core library module

Namespaces

namespace QgsHstoreUtils

The QgsHstoreUtils namespace provides functions to handle hstore-formatted strings.

Classes

struct QgsAbstractMetadataBase::Address

Metadata address structure.

class QgsAbstractGeometry::const_part_iterator

The part_iterator class provides STL-style iterator for const references to geometry parts.

struct QgsAbstractMetadataBase::Contact

Metadata contact structure.

class pal::CostCalculator

class QgsLayerDefinition::DependencySorter

Class used to work with layer dependencies stored in a XML project or layer definition file.

class pal::InternalException::Empty

Thrown when trying to access an empty data set.

class pal::Feats

For usage in problem solving algorithm.

class pal::PalException::FeatureExists

features already exists

class pal::FeaturePart

Main class to handle feature.

struct QgsRuleBasedRenderer::FeatureToRender

Feature for rendering by a QgsRuleBasedRenderer.

class QgsRelation::FieldPair

Defines a relation between matching fields of the two involved tables of a relation.

class QgsVectorFileWriter::FieldValueConverter

Interface to convert raw field values to their user-friendly value.

class pal::InternalException::Full

Thrown when something is added in a Full set.

class pal::GeomFunction

class QgsSnappingConfig::IndividualLayerSettings

This is a container of advanced configuration (per layer) of the snapping of the project.

class pal::InternalException

Various Exceptions.

class pal::LabelInfo

Optional additional info about label (for curved labels)

class pal::LabelPosition

LabelPosition is a candidate feature label position.

class pal::Layer

A set of features which influence the labeling process.

class QgsProcessingContext::LayerDetails

Details for layers to load into projects.

class pal::PalException::LayerExists

layer already exists

class QgsOgcUtils::LayerProperties

Layer properties.

class QgsGmlStreamingParser::LayerProperties

Layer properties.

struct QgsAbstractMetadataBase::Link

Metadata link structure.

class QgsMapThemeCollection::MapThemeLayerRecord

Individual record of a visible layer in a map theme record.

class QgsMapThemeCollection::MapThemeRecord

Individual map theme record of visible layers and styles.

class QgsProjectStorage::Metadata

Metadata associated with a project.

struct QgsExpressionNode::NamedNode

Named node.

class QgsSQLStatement::Node

Abstract node class.

class QgsSQLStatement::NodeBetweenOperator

'X BETWEEN y and z' operator

class QgsSQLStatement::NodeBinaryOperator

Binary logical/arithmetical operator (AND, OR, =, +, ...)

class QgsSQLStatement::NodeCast

CAST operator.

class QgsSQLStatement::NodeColumnRef

Reference to a column.

class QgsSQLStatement::NodeColumnSorted

Column in a ORDER BY.

class QgsSQLStatement::NodeFunction

Function with a name and arguments node.

class QgsSQLStatement::NodeInOperator

'x IN (y, z)' operator

class QgsSQLStatement::NodeJoin

Join definition.

class QgsExpressionNode::NodeList

A list of expression nodes.

class QgsSQLStatement::NodeList

A list of nodes.

class QgsSQLStatement::NodeLiteral

Literal value (integer, integer64, double, string)

class QgsSQLStatement::NodeSelect

SELECT node.

class QgsSQLStatement::NodeSelectedColumn

Selected column.

class QgsSQLStatement::NodeTableDef

Table definition.

class QgsSQLStatement::NodeUnaryOperator

Unary logicial/arithmetical operator ( NOT, - )

class pal::InternalException::NoLabelPosition

Throw an exception when it's impossible to compute labelPosition.

class pal::PalException::NotImplemented

Thrown when a feature is not yet implemented.

class QgsFeatureRequest::OrderBy

Represents a list of OrderByClauses, with the most important first and the least important last.

class QgsFeatureRequest::OrderByClause

The OrderByClause class represents an order by clause for a QgsFeatureRequest.

class pal::Pal

Main Pal labeling class.

class pal::PalException

Various Exceptions.

class pal::PalStat

Summary statistics of labeling problem.

class QgsExpressionFunction::Parameter

Represents a single parameter passed to a function.

class QgsAbstractGeometry::part_iterator

The part_iterator class provides STL-style iterator for geometry parts.

class pal::PointSet

class pal::PolygonCostCalculator

Data structure to compute polygon's candidates costs.

class pal::PriorityQueue

class pal::Problem

Representation of a labeling problem.

class Qgis

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

class QgisVisitor

Custom visitor that adds found features to list.

class Qgs3DRendererAbstractMetadata

Base metadata class for 3D renderers.

class Qgs3DRendererRegistry

Keeps track of available 3D renderers.

class QgsAbstract3DRenderer

Base class for all renderers that may to participate in 3D view.

class QgsAbstractCacheIndex

Abstract base class for cache indices.

template<class T>

class QgsAbstractContentCache

Abstract base class for file content caches, such as SVG or raster image caches.

class QgsAbstractContentCacheBase

A QObject derived base class for QgsAbstractContentCache.

class QgsAbstractContentCacheEntry

Base class for entries in a QgsAbstractContentCache.

class QgsAbstractFeatureIterator

Internal feature iterator to be implemented within data providers.

template<typename T>

class QgsAbstractFeatureIteratorFromSource

Helper template that cares of two things: 1.

class QgsAbstractFeatureSource

Base class that can be used for any class that is capable of returning features.

class QgsAbstractGeometry

Abstract base class for all geometries.

class QgsAbstractGeometrySimplifier

Abstract base class for simplify geometries using a specific algorithm.

class QgsAbstractLabelProvider

The QgsAbstractLabelProvider class is an interface class.

class QgsAbstractLayoutIterator

An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.

class QgsAbstractLayoutUndoCommand

Base class for commands to undo/redo layout and layout object changes.

class QgsAbstractMetadataBase

An abstract base class for metadata stores.

class QgsAbstractMetadataBaseValidator

Abstract base class for metadata validators.

class QgsAbstractPropertyCollection

Abstract base class for QgsPropertyCollection like objects.

class QgsAbstractValidityCheck

Abstract base class for individual validity checks.

class QgsAbstractVectorLayerLabeling

Abstract base class - its implementations define different approaches to the labeling of a vector layer.

class QgsAction

Utility class that encapsulates an action based on vector attributes.

class QgsActionManager

Storage and management of actions associated with a layer.

class QgsActionScope

An action scope defines a "place" for an action to be shown and may add additional expression variables.

class QgsActionScopeRegistry

The action scope registry is an application wide registry that contains a list of available action scopes.

class QgsAggregateCalculator

Utility class for calculating aggregates for a field (or expression) over the features from a vector layer.

class QgsAnimatedIcon

Animated icon is keeping an animation running if there are listeners connected to frameChanged.

class QgsAnnotation

Abstract base class for annotation items which are drawn over a map.

class QgsAnnotationManager

Manages storage of a set of QgsAnnotation annotation objects.

class QgsApplication

Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc.

class QgsArchive

Class allowing to manage the zip/unzip actions.

class QgsArrayFilterExpressionFunction

Handles the array_filter(array, expression) expression function.

class QgsArrayForeachExpressionFunction

Handles the array_foreach(array, expression) expression function.

class QgsArrowSymbolLayer

Line symbol layer used for representing lines as arrows.

class QgsAttributeEditorContainer

This is a container for attribute editors, used to group them visually in the attribute form if it is set to the drag and drop designer.

class QgsAttributeEditorElement

This is an abstract base class for any elements of a drag and drop form.

class QgsAttributeEditorField

This element will load a field's widget onto the form.

class QgsAttributeEditorQmlElement

An attribute editor widget that will represent arbitrary QML code.

class QgsAttributeEditorRelation

This element will load a relation editor onto the form.

class QgsAttributes

A vector of attributes.

class QgsAttributeTableConfig

This is a container for configuration of the attribute table.

class QgsAuthCertUtils

Utilities for working with certificates and keys.

class QgsAuthConfigSslServer

Configuration container for SSL server connection exceptions or overrides.

class QgsAuthCrypto

Functions for hashing/checking master password and encrypt/decrypting data with password.

class QgsAuthManager

Singleton offering an interface to manage the authentication configuration database and to utilize configurations through various authentication method plugins.

class QgsAuthMethod

Abstract base class for authentication method plugins.

class QgsAuthMethodConfig

Configuration storage class for authentication method configurations.

class QgsAuthMethodMetadata

Holds data auth method key, description, and associated shared library file information.

class QgsAuthMethodRegistry

A registry / canonical manager of authentication methods.

class QgsAuxiliaryLayer

Class allowing to manage the auxiliary storage for a vector layer.

class QgsAuxiliaryStorage

Class providing some utility methods to manage auxiliary storage.

class QgsBearingUtils

Utilities for calculating bearings and directions.

class QgsBilinearRasterResampler

Bilinear Raster Resampler.

class QgsBlurEffect

A paint effect which blurs a source picture, using a number of different blur methods.

class QgsBox3d

A 3-dimensional box composed of x, y, z coordinates.

class QgsBrightnessContrastFilter

Brightness/contrast filter pipe for rasters.

class QgsBrowserModel

A model for showing available data sources and other items in a structured tree.

class QgsBrowserProxyModel

A QSortFilterProxyModel subclass for filtering and sorting browser model items.

class QgsBrowserWatcher

class QgsCachedFeatureIterator

Delivers features from the cache.

class QgsCachedFeatureWriterIterator

Uses another iterator as backend and writes features to the cache.

class QgsCadUtils

The QgsCadUtils class provides routines for CAD editing.

class QgsCircle

Circle geometry type.

class QgsCircularString

Circular string geometry type.

class QgsClipper

A class to trim lines and polygons to within a rectangular region.

class QgsClipToMinMaxEnhancement

A raster contrast enhancement that will clip a value to the specified min/max range.

class QgsColorBrewerColorRamp

Color ramp utilising "Color Brewer" preset color schemes.

class QgsColorEffect

A paint effect which alters the colors (e.g., brightness, contrast) in a source picture.

class QgsColorRamp

Abstract base class for color ramps.

class QgsColorRampShader

A ramp shader will color a raster pixel based on a list of values ranges in a ramp.

class QgsColorRampTransformer

QgsPropertyTransformer subclass for transforming a numeric value into a color from a color ramp.

class QgsColorScheme

Abstract base class for color schemes.

class QgsColorSchemeRegistry

Registry of color schemes.

class QgsCompositionConverter

QgsCompositionConverter class converts a QGIS 2.x composition to a QGIS 3.x layout.

class QgsCompoundCurve

Compound curve geometry type.

class QgsConditionalLayerStyles

The QgsConditionalLayerStyles class holds conditional style information for a layer.

class QgsConditionalStyle

Conditional styling for a rule.

template<typename T, typename T_Group>

class QgsConnectionPool

Template class responsible for keeping a pool of open connections.

template<typename T>

class QgsConnectionPoolGroup

Template that stores data related to a connection to a single server or datasource.

class QgsContrastEnhancement

Manipulates raster pixel values so that they enhanceContrast or clip into a specified numerical range according to the specified ContrastEnhancementAlgorithm.

class QgsContrastEnhancementFunction

A contrast enhancement function is the base class for all raster contrast enhancements.

class QgsCoordinateFormatter

Contains methods for converting coordinates for display in various formats.

class QgsCoordinateReferenceSystem

This class represents a coordinate reference system (CRS).

class QgsCoordinateTransform

Class for doing transforms between two map coordinate systems.

class QgsCoordinateTransformContext

Contains information about the context in which a coordinate transform is executed.

class QgsCptCityAllRampsItem

An "All ramps item", which contains all items in a flat hierarchy.

class QgsCptCityCollectionItem

A Collection: logical collection of subcollections and color ramps.

class QgsCptCityColorRampItem

Item that represents a layer that can be opened with one of the providers.

class QgsCptCityDataItem

Base class for all items in the model.

class QgsCptCityDirectoryItem

A directory: contains subdirectories and color ramps.

class QgsCptCitySelectionItem

A selection: contains subdirectories and color ramps.

class QgsCredentials

Interface for requesting credentials in QGIS in GUI independent way.

class QgsCredentialsConsole

Implementation of credentials interface for the console.

class QgsCredentialsNone

Default implementation of credentials interface.

class QgsCsException

Custom exception class for Coordinate Reference System related exceptions.

class QgsCubicRasterResampler

Cubic Raster Resampler.

class QgsCurve

Abstract base class for curved geometry type.

class QgsCurvePolygon

Curve polygon geometry type.

class QgsCurveTransform

Handles scaling of input values to output values by using a curve created from smoothly joining a number of set control points.

class QgsCustomColorScheme

A color scheme which contains custom colors set through QGIS app options dialog.

class QgsDatabaseFilterProxyModel

A class that implements a custom filter and can be used as a proxy for QgsDbTableModel.

class QgsDataCollectionItem

A Collection: logical collection of layers or subcollections, e.g.

class QgsDataDefinedSizeLegend

Object that keeps configuration of appearance of marker symbol's data-defined size in legend.

class QgsDataDefinedSizeLegendNode

Produces legend node with a marker symbol.

class QgsDataItem

Base class for all items in the model.

class QgsDataItemProvider

This is the interface for those who want to add custom data items to the browser tree.

class QgsDataItemProviderFromPlugin

Simple data item provider implementation that handles the support for provider plugins (which may contain dataCapabilities() and dataItem() functions).

class QgsDataItemProviderRegistry

This class keeps a list of data item providers that may add items to the browser tree.

class QgsDataProvider

Abstract base class for spatial data provider implementations.

class QgsDataSourceUri

Class for storing the component parts of a PostgreSQL/RDBMS datasource URI.

class QgsDateTimeFieldFormatter

Field formatter for a date time field.

class QgsDateTimeStatisticalSummary

Calculator for summary statistics and aggregates for a list of datetimes.

class QgsDatumTransform

Contains methods and classes relating the datum transformations.

class QgsDefaultMeshLayerLegend

Default legend implementation for mesh layers.

class QgsDefaultRasterLayerLegend

Default legend implementation for raster layers.

class QgsDefaultValue

The QgsDefaultValue class provides a container for managing client side default values for fields.

class QgsDefaultVectorLayerLegend

Default legend implementation for vector layers.

class QgsDiagram

Base class for all diagram types.

class QgsDiagramInterpolationSettings

Additional diagram settings for interpolated size rendering.

class QgsDiagramLabelFeature

Class that adds extra information to QgsLabelFeature for labeling of diagrams.

class QgsDiagramLayerSettings

Stores the settings for rendering of all diagrams for a layer.

class QgsDiagramRenderer

Evaluates and returns the diagram settings relating to a diagram for a specific feature.

class QgsDiagramSettings

Stores the settings for rendering a single diagram.

class QgsDirectoryItem

A directory: contains subdirectories and layers.

class QgsDistanceArea

A general purpose distance and area calculator, capable of performing ellipsoid based calculations.

class QgsDoubleBoxScaleBarRenderer

Double box with alternating colors.

class QgsDrawSourceEffect

A paint effect which draws the source picture with minor or no alterations.

class QgsDropShadowEffect

A paint effect which draws an offset and optionally blurred drop shadow.

class QgsVectorLayerUtils::QgsDuplicateFeatureContext

Contains mainly the QMap with QgsVectorLayer and QgsFeatureIds do list all the duplicated features.

class QgsDxfLabelProvider

Implements a derived label provider internally used for DXF export.

class QgsDxfPaintDevice

A paint device for drawing into dxf files.

class QgsDxfPaintEngine

class QgsDxfRuleBasedLabelProvider

Implements a derived label provider for rule based labels internally used for DXF export.

class QgsEditorWidgetSetup

Holder for the widget type and its configuration for a field.

class QgsEffectPainter

A class to manager painter saving and restoring required for effect drawing.

class QgsEffectStack

A paint effect which consists of a stack of other chained paint effects.

class QgsEllipse

Ellipse geometry type.

class QgsEllipseSymbolLayer

A symbol layer for rendering objects with major and minor axis (e.g.

class QgsEllipsoidUtils

Contains utility functions for working with ellipsoids and querying the ellipsoid database.

class QgsError

QgsError is container for error messages (report).

class QgsErrorItem

Data item that can be used to report problems (e.g.

class QgsErrorMessage

QgsErrorMessage represents single error message.

class QgsException

Defines a QGIS exception class.

class QgsExpression

Class for parsing and evaluation of expressions (formerly called "search strings").

class QgsExpressionContext

Expression contexts are used to encapsulate the parameters around which a QgsExpression should be evaluated.

class QgsExpressionContextGenerator

Abstract interface for generating an expression context.

class QgsExpressionContextScope

Single scope for storing variables and functions for use within a QgsExpressionContext.

class QgsExpressionContextScopeGenerator

Abstract interface for generating an expression context scope.

class QgsExpressionContextUtils

Contains utilities for working with QgsExpressionContext objects, including methods for creating scopes for specific uses (e.g., project scopes, layer scopes).

class QgsExpressionFieldBuffer

Buffers information about expression fields for a vector layer.

class QgsExpressionFunction

A abstract base class for defining QgsExpression functions.

class QgsExpressionNode

Abstract base class for all nodes that can appear in an expression.

class QgsExpressionNodeBinaryOperator

A binary expression operator, which operates on two values.

class QgsExpressionNodeColumnRef

An expression node which takes it value from a feature's field.

class QgsExpressionNodeCondition

An expression node for CASE WHEN clauses.

class QgsExpressionNodeFunction

An expression node for expression functions.

class QgsExpressionNodeIndexOperator

A indexing expression operator, which allows use of square brackets [] to reference map and array items.

class QgsExpressionNodeInOperator

An expression node for value IN or NOT IN clauses.

class QgsExpressionNodeLiteral

An expression node for literal values.

class QgsExpressionNodeUnaryOperator

A unary node is either negative as in boolean (not) or as in numbers (minus).

class QgsFallbackFieldFormatter

A default fallback field formatter in case no specialized field formatter is defined.

class QgsFavoritesItem

Contains various Favorites directories.

class QgsFeature

The feature class encapsulates a single feature including its id, geometry and a list of field/values attributes.

class QgsFeatureFilterModel

Provides a list of features based on filter conditions.

class QgsFeatureFilterProvider

Abstract interface for use by classes that filter the features of a layer.

class QgsFeatureIterator

Wrapper for iterator of features from vector data provider or vector layer.

class QgsFeatureIteratorDataStream

Utility class for bulk loading of R-trees.

class QgsFeatureRequest

This class wraps a request for features to a vector layer (or directly its vector data provider).

class QgsFeatureSink

An interface for objects which accept features via addFeature(s) methods.

class QgsFeatureSource

An interface for objects which provide features via a getFeatures method.

class QgsFeatureStore

A container for features with the same fields and crs.

class QgsFeedback

Base class for feedback objects to be used for cancelation of something running in a worker thread.

class QgsFetchedContent

FetchedContent holds useful information about a network content being fetched.

class QgsField

Encapsulate a field in an attribute table or data source.

class QgsFieldConstraints

Stores information about constraints which may be present on a field.

class QgsFieldFormatter

A field formatter helps to handle and display values for a field.

class QgsFieldFormatterRegistry

The QgsFieldFormatterRegistry manages registered classes of QgsFieldFormatter.

class QgsFieldModel

The QgsFieldModel class is a model to display the list of fields of a layer in widgets.

class QgsFieldProxyModel

The QgsFieldProxyModel class provides an easy to use model to display the list of fields of a layer.

class QgsFields

Container of fields for a vector layer.

class QgsFileDownloader

QgsFileDownloader is a utility class for downloading files.

class QgsFileUtils

Class for file utilities.

class QgsFilledMarkerSymbolLayer

Filled marker symbol layer, consisting of a shape which is rendered using a QgsFillSymbol.

class QgsGdalUtils

Utilities for working with GDAL.

class QgsGenericNumericTransformer

QgsPropertyTransformer subclass for scaling an input numeric value into an output numeric value.

class QgsGeometry

A geometry is the spatial representation of a feature.

class QgsGeometryCollection

Geometry collection.

class QgsGeometryConstPartIterator

Java-style iterator for const traversal of parts of a geometry.

class QgsGeometryEditUtils

Convenience functions for geometry editing.

class QgsGeometryEngine

Contains geometry relation and modification algorithms.

class QgsGeometryFactory

Contains geometry creation routines.

class QgsGeometryOptions

The QgsGeometryOptions class contains options to automatically adjust geometries to constraints on a layer.

class QgsGeometryPartIterator

Java-style iterator for traversal of parts of a geometry.

class QgsGeometryUtils

Contains various geometry utility functions.

class QgsGeoNodeConnection

Encapsulates settings related to a single GeoNode connection.

class QgsGeoNodeConnectionUtils

Contains various utilities for managing the known collection of GeoNode servers associated with a QGIS install.

class QgsGeoNodeRequest

Request handler for GeoNode servers.

class QgsGeoNodeStyle

Encapsulates information about a GeoNode layer style.

class QgsGeos

Does vector analysis using the geos library and handles import, export, exception handling*.

class QgsGlowEffect

Base class for paint effect which draw a glow inside or outside a picture.

class QgsGml

This class reads data from a WFS server or alternatively from a GML file.

class QgsGmlFeatureClass

Description of feature class in GML.

class QgsGmlStreamingParser

This class builds features from GML data in a streaming way.

class QgsGplColorScheme

A color scheme which stores its colors in a gpl palette file.

class QgsGpsConnection

Abstract base class for connection to a GPS device.

class QgsGpsConnectionRegistry

A class to register / unregister existing GPS connections such that the information is available to all classes and plugins.

class QgsGpsdConnection

Evaluates NMEA sentences coming from gpsd.

class QgsGpsDetector

Class to detect the GPS port.

class QgsGradientColorRamp

Gradient color ramp, which smoothly interpolates between two colors and also supports optional extra color stops.

class QgsGradientStop

Represents a color stop within a QgsGradientColorRamp color ramp.

class QgsHeatmapRenderer

A renderer which draws points as a live heatmap.

class QgsHillshadeRenderer

A renderer for generating live hillshade models.

class QgsHistogram

Calculator for a numeric histogram from a list of values.

class QgsHtmlAnnotation

An annotation item that embeds HTML content.

class QgsHtmlUtils

Class for HTML utilities.

class QgsHueSaturationFilter

Color and saturation filter pipe for rasters.

class QgsImageCache

A cache for images derived from raster files.

class QgsImageFetcher

Handles asynchronous download of images.

class QgsImageFillSymbolLayer

Base class for polygon renderers generating texture images.

class QgsImageLegendNode

Implementation of legend node interface for displaying arbitrary raster image.

class QgsImageOperation

Contains operations and filters which apply to QImages.

class QgsIndexedFeature

Temporarily used structure to cache order by information.

class QgsInnerGlowEffect

A paint effect which draws a glow within a picture.

class QgsInnerShadowEffect

A paint effect which draws an offset and optionally blurred drop shadow within a picture.

class QgsInternalGeometryEngine

This class offers geometry processing methods.

class QgsInterval

A representation of the interval between two datetime values.

class QgsInvertedPolygonRenderer

QgsInvertedPolygonRenderer is a polygon-only feature renderer used to display features inverted, where the exterior is turned to an interior and where the exterior theoretically spans the entire plane, allowing to mask the surroundings of some features.

class QgsJsonExporter

Handles exporting QgsFeature features to GeoJSON features.

class QgsJsonUtils

Helper utilities for working with JSON and GeoJSON conversions.

class QgsKeyValueFieldFormatter

Field formatter for a key value field.

class QgsLabelBlockingRegion

Label blocking region (in map coordinates and CRS).

class QgsLabelFeature

The QgsLabelFeature class describes a feature that should be used within the labeling engine.

class QgsLabelingEngine

The QgsLabelingEngine class provides map labeling functionality.

class QgsLabelingEngineSettings

Stores global configuration for labeling engine.

class QgsLabelingResults

Class that stores computed placement from labeling engine.

class QgsLabelingUtils

Contains helper utilities for working with QGIS' labeling engine.

class QgsLabelSearchTree

A class to query the labeling structure at a given point (small wrapper around pal RTree class)

class QgsLabelSorter

Helper class for sorting labels into correct draw order.

class QgsLayerDefinition

The QgsLayerDefinition class holds generic methods for loading/exporting QLR files.

class QgsLayerItem

Item that represents a layer that can be opened with one of the providers.

class QgsLayerMetadata

A structured metadata store for a map layer.

class QgsLayerMetadataFormatter

Class for metadata formatter.

class QgsLayerTree

Namespace with helper functions for layer tree operations.

class QgsLayerTreeGroup

Layer tree group node serves as a container for layers and further groups.

class QgsLayerTreeLayer

Layer tree node points to a map layer.

class QgsLayerTreeModel

The QgsLayerTreeModel class is model implementation for Qt item views framework.

class QgsLayerTreeModelLegendNode

The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegend implementation.

class QgsLayerTreeNode

This class is a base class for nodes in a layer tree.

class QgsLayerTreeRegistryBridge

Listens to the updates in map layer registry and does changes in layer tree.

class QgsLayerTreeUtils

Assorted functions for dealing with layer trees.

class QgsLayout

Base class for layouts, which can contain items such as maps, labels, scalebars, etc.

class QgsLayoutAligner

Handles aligning and distributing sets of layout items.

class QgsLayoutAtlas

Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector layer.

class QgsLayoutEffect

A QGraphicsEffect subclass used for rendering layout items onto a scene with custom composition modes.

class QgsLayoutExporter

Handles rendering and exports of layouts to various formats.

class QgsLayoutFrame

Base class for frame items, which form a layout multiframe item.

class QgsLayoutGridSettings

Contains settings relating to the appearance, spacing and offset for layout grids.

class QgsLayoutGuide

Contains the configuration for a single snap guide used by a layout.

class QgsLayoutGuideCollection

Stores and manages the snap guides used by a layout.

class QgsLayoutGuideProxyModel

Filters QgsLayoutGuideCollection models to guides of a single orientation (horizontal or vertical).

class QgsLayoutItem

Base class for graphical items within a QgsLayout.

class QgsLayoutItemAbstractMetadata

Stores metadata about one layout item class.

class QgsLayoutItemAttributeTable

A layout table subclass that displays attributes from a vector layer.

class QgsLayoutItemGroup

A container for grouping several QgsLayoutItems.

class QgsLayoutItemGuiRegistry

Registry of available layout item GUI behavior.

class QgsLayoutItemHtml

A layout multiframe subclass for HTML content.

class QgsLayoutItemLabel

A layout item subclass for text labels.

class QgsLayoutItemLegend

A layout item subclass for map legends.

class QgsLayoutItemMap

Layout graphical items for displaying a map.

class QgsLayoutItemMapGrid

An individual grid which is drawn above the map content in a QgsLayoutItemMap.

class QgsLayoutItemMapGridStack

A collection of grids which is drawn above the map content in a QgsLayoutItemMap.

class QgsLayoutItemMapItem

An item which is drawn inside a QgsLayoutItemMap, e.g., a grid or map overview.

class QgsLayoutItemMapItemStack

A collection of map items which are drawn above the map content in a QgsLayoutItemMap.

class QgsLayoutItemMapOverview

An individual overview which is drawn above the map content in a QgsLayoutItemMap, and shows the extent of another QgsLayoutItemMap.

class QgsLayoutItemMapOverviewStack

A collection of overviews which are drawn above the map content in a QgsLayoutItemMap.

class QgsLayoutItemMetadata

Convenience metadata class that uses static functions to create layout items and their configuration widgets.

class QgsLayoutItemPage

Item representing the paper in a layout.

class QgsLayoutItemPicture

A layout item subclass that displays SVG files or raster format images (jpg, png, ...).

class QgsLayoutItemPolygon

Layout item for node based polygon shapes.

class QgsLayoutItemPolyline

Layout item for node based polyline shapes.

class QgsLayoutItemRegistry

Registry of available layout item types.

class QgsLayoutItemRenderContext

Contains settings and helpers relating to a render of a QgsLayoutItem.

class QgsLayoutItemScaleBar

A layout item subclass for scale bars.

class QgsLayoutItemShape

Layout item for basic filled shapes (e.g.

class QgsLayoutItemTextTable

A text table item that reads text from string lists.

class QgsLayoutManager

Manages storage of a set of layouts.

class QgsLayoutMeasurement

This class provides a method of storing measurements for use in QGIS layouts using a variety of different measurement units.

class QgsLayoutMeasurementConverter

This class provides a method of converting QgsLayoutMeasurements from one unit to another.

class QgsLayoutModel

A model for items attached to a layout.

class QgsLayoutMultiFrame

Abstract base class for layout items with the ability to distribute the content to several frames (QgsLayoutFrame items).

class QgsLayoutMultiFrameAbstractMetadata

Stores metadata about one layout multiframe class.

class QgsLayoutMultiFrameMetadata

Convenience metadata class that uses static functions to create layout multiframes and their configuration widgets.

class QgsLayoutNodesItem

An abstract layout item that provides generic methods for node based shapes such as polygon or polylines.

class QgsLayoutObject

A base class for objects which belong to a layout.

class QgsLayoutPageCollection

A manager for a collection of pages in a layout.

class QgsLayoutPoint

This class provides a method of storing points, consisting of an x and y coordinate, for use in QGIS layouts.

class QgsLayoutProxyModel

Allows for filtering a QgsLayoutModel by item type.

class QgsLayoutRenderContext

Stores information relating to the current rendering settings for a layout.

class QgsLayoutReportContext

Stores information relating to the current reporting context for a layout.

class QgsLayoutSerializableObject

An interface for layout objects which can be stored and read from DOM elements.

class QgsLayoutSize

This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layouts.

class QgsLayoutSnapper

Manages snapping grids and preset snap lines in a layout, and handles snapping points to the nearest grid coordinate/snap line when possible.

class QgsLayoutTable

A class to display a table in the print layout, and allow the table to span over multiple frames.

class QgsLayoutTableColumn

Stores properties of a column for a QgsLayoutTable.

class QgsLayoutTableStyle

Styling option for a composer table cell.

class QgsLayoutUndoObjectInterface

Interface for layout objects which support undo/redo commands.

class QgsLayoutUndoStack

An undo stack for QgsLayouts.

class QgsLayoutUtils

Utilities for layouts.

class QgsLayoutValidityCheckContext

Validity check context for print layout validation.

class QgsLegendModel

Item model implementation based on layer tree model for layout legend.

class QgsLegendRenderer

The QgsLegendRenderer class handles automatic layout and rendering of legend.

class QgsLegendSettings

The QgsLegendSettings class stores the appearance and layout settings for legend drawing with QgsLegendRenderer.

class QgsLegendStyle

Composer legend components style.

class QgsLegendSymbolItem

The class stores information about one class/rule of a vector layer renderer in a unified way that can be used by legend model for rendering of legend.

class QgsLimitedRandomColorRamp

Constrained random color ramp, which returns random colors based on preset parameters.

class QgsLinearMinMaxEnhancement

A color enhancement function that performs a linear enhanceContrast between min and max.

class QgsLinearMinMaxEnhancementWithClip

A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max.

class QgsLinePatternFillSymbolLayer

A symbol fill consisting of repeated parallel lines.

class QgsLineSegment2D

Represents a single 2D line segment, consisting of a 2D start and end vertex only.

class QgsLineString

Line string geometry type, with support for z-dimension and m-values.

class QgsListFieldFormatter

Field formatter for a list field.

class QgsLocator

Handles the management of QgsLocatorFilter objects and async collection of search results from them.

class QgsLocatorAutomaticModel

A QgsLocatorModel which has is associated directly with a QgsLocator, and is automatically populated with results from locator searches.

class QgsLocatorContext

Encapsulates the properties relating to the context of a locator search.

class QgsLocatorFilter

Abstract base class for filters which collect locator results.

class QgsLocatorModel

An abstract list model for displaying the results of locator searches.

class QgsLocatorModelBridge

The QgsLocatorModelBridge class provides the core functionality to be used in a locator widget.

class QgsLocatorProxyModel

A sort proxy model for QgsLocatorModel, which automatically sorts results by precedence.

class QgsLocatorResult

Encapsulates properties of an individual matching result found by a QgsLocatorFilter.

class QgsLogger

QgsLogger is a class to print debug/warning/error messages to the console.

class QgsMapDecoration

Interface for map decorations.

class QgsMapHitTest

Class that runs a hit test with given map settings.

class QgsMapLayer

Base class for all map layer types.

class QgsMapLayerDependency

This class models dependencies with or between map layers.

class QgsMapLayerLegend

The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.

class QgsMapLayerLegendUtils

Miscellaneous utility functions for handling of map layer legend.

class QgsMapLayerModel

The QgsMapLayerModel class is a model to display layers in widgets.

class QgsMapLayerProxyModel

The QgsMapLayerProxyModel class provides an easy to use model to display the list of layers in widgets.

class QgsMapLayerRenderer

Base class for utility classes that encapsulate information necessary for rendering of map layers.

class QgsMapLayerStore

A storage object for map layers, in which the layers are owned by the store and have their lifetime bound to the store.

class QgsMapLayerStyle

Stores style information (renderer, opacity, labeling, diagrams etc.) applicable to a map layer.

class QgsMapLayerStyleManager

Management of styles for use with one map layer.

class QgsMapLayerStyleOverride

Restore overridden layer style on destruction.

class QgsMapRendererCache

This class is responsible for keeping cache of rendered images resulting from a map rendering job.

class QgsMapRendererCustomPainterJob

Job implementation that renders everything sequentially using a custom painter.

class QgsMapRendererJob

Abstract base class for map rendering implementations.

class QgsMapRendererParallelJob

Job implementation that renders all layers in parallel.

class QgsMapRendererQImageJob

Intermediate base class adding functionality that allows client to query the rendered image.

class QgsMapRendererSequentialJob

Job implementation that renders everything sequentially in one thread.

class QgsMapRendererTask

QgsTask task which draws a map to an image file or a painter as a background task.

class QgsMapSettings

The QgsMapSettings class contains configuration for rendering of the map.

class QgsMapSettingsUtils

Utilities for map settings.

class QgsMapThemeCollection

Container class that allows storage of map themes consisting of visible map layers and layer styles.

class QgsMapToPixel

Perform transforms between map coordinates and device coordinates.

class QgsMapToPixelSimplifier

Implementation of GeometrySimplifier using the "MapToPixel" algorithm.

class QgsMapUnitScale

Struct for storing maximum and minimum scales for measurements in map units.

class QgsMargins

The QgsMargins class defines the four margins of a rectangle.

class QgsMarkerSymbolLayer

Abstract base class for marker symbol layers.

class QgsMasterLayoutInterface

Interface for master layout type objects, such as print layouts and reports.

class QgsMemoryProviderUtils

Utility functions for use with the memory vector data provider.

struct QgsMesh

Mesh - vertices and faces.

class QgsMeshDataBlock

QgsMeshDataBlock is a block of integers/doubles that can be used to retrieve: active flags (e.g.

class QgsMeshDataProvider

Base class for providing data for QgsMeshLayer.

class QgsMeshDatasetGroupMetadata

QgsMeshDatasetGroupMetadata is a collection of dataset group metadata such as whether the data is vector or scalar, name.

class QgsMeshDatasetIndex

QgsMeshDatasetIndex is index that identifies the dataset group (e.g.

class QgsMeshDatasetMetadata

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset.

class QgsMeshDatasetSourceInterface

Interface for mesh datasets and dataset groups.

class QgsMeshDatasetValue

QgsMeshDatasetValue represents single dataset value.

class QgsMeshDataSourceInterface

Interface for mesh data sources.

class QgsMeshLayer

Represents a mesh layer supporting display of data on structured or unstructured meshes.

class QgsMeshLayerRenderer

Implementation of threaded rendering for mesh layers.

class QgsMeshRendererMeshSettings

Represents a mesh renderer settings for mesh object.

class QgsMeshRendererScalarSettings

Represents a mesh renderer settings for scalar datasets.

class QgsMeshRendererSettings

Represents all mesh renderer settings.

class QgsMeshRendererVectorSettings

Represents a mesh renderer settings for vector datasets.

class QgsMessageLog

Interface for logging messages from QGIS in GUI independent way.

class QgsMessageLogConsole

Default implementation of message logging interface.

class QgsMessageLogNotifyBlocker

Temporarily blocks the application QgsMessageLog (see QgsApplication::messageLog()) from emitting the messageReceived( bool ) signal for the lifetime of the object.

class QgsMessageOutput

Interface for showing messages from QGIS in GUI independent way.

class QgsMessageOutputConsole

Default implementation of message output interface.

class QgsMultiBandColorRenderer

Renderer for multiband images with the color components.

class QgsMultiCurve

Multi curve geometry collection.

class QgsMultiLineString

Multi line string geometry collection.

class QgsMultiPoint

Multi point geometry collection.

class QgsMultiPolygon

Multi polygon geometry collection.

class QgsMultiRenderChecker

This class allows checking rendered images against comparison images.

class QgsMultiSurface

Multi surface geometry collection.

class QgsNativeMetadataBaseValidator

A validator for the native base QGIS metadata schema definition.

class QgsNativeMetadataValidator

A validator for the native QGIS layer metadata schema definition.

class QgsNativeProjectMetadataValidator

A validator for the native QGIS project metadata schema definition.

class QgsNetworkAccessManager

network access manager for QGIS

class QgsNetworkContentFetcher

HTTP network content fetcher.

class QgsNetworkContentFetcherRegistry

Registry for temporary fetched files.

class QgsNetworkContentFetcherTask

Handles HTTP network content fetching in a background task.

class QgsNetworkDiskCache

Wrapper implementation of QNetworkDiskCache with all methods guarded by a mutex soly for internal use of QgsNetworkAccessManagers.

class QgsNetworkReplyParser

Multipart QNetworkReply parser.

class QgsNmeaConnection

Evaluates NMEA sentences coming from a GPS device.

class QgsNullSymbolRenderer

Null symbol renderer.

class QgsNumericScaleBarRenderer

A scale bar style that draws text in the form of '1:XXXXX'.

class QgsObjectCustomProperties

Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML in.

class QgsOgcUtils

The QgsOgcUtils class provides various utility functions for conversion between OGC (Open Geospatial Consortium) standards and QGIS internal representations.

class QgsOgcUtilsExpressionFromFilter

Internal use by QgsOgcUtils.

class QgsOgcUtilsExprToFilter

Internal use by QgsOgcUtils.

class QgsOgcUtilsSQLStatementToFilter

Internal use by QgsOgcUtils.

class QgsOgrUtils

Utilities for working with OGR features and layers.

class QgsOpenClUtils

The QgsOpenClUtils class is responsible for common OpenCL operations such as.

template<typename T>

class QgsOptional

QgsOptional is a container for other classes and adds an additional enabled/disabled flag.

class QgsOptionalExpression

An expression with an additional enabled flag.

class QgsOuterGlowEffect

A paint effect which draws a glow outside of a picture.

class QgsOwsConnection

Connections management.

class QgsPageSize

A named page size for layouts.

class QgsPageSizeRegistry

A registry for known page sizes.

class QgsPaintEffect

Base class for visual effects which can be applied to QPicture drawings.

class QgsPaintEffectAbstractMetadata

Stores metadata about a paint effect class.

class QgsPaintEffectMetadata

Convenience metadata class that uses static functions to create an effect and its widget.

class QgsPaintEffectRegistry

Registry of available paint effects.

class QgsPaintEngineHack

Hack to workaround Qt #5114 by disabling PatternTransform.

class QgsPainting

Misc painting enums and functions.

class QgsPalettedRasterRenderer

Renderer for paletted raster images.

class QgsPathResolver

Resolves relative paths into absolute paths and vice versa.

class QgsPkiBundle

Storage set for PKI bundle: SSL certificate, key, optional CA cert chain.

class QgsPkiConfigBundle

Storage set for constructed SSL certificate, key, associated with an authentication config.

class QgsPluginLayer

Base class for plugin layers.

class QgsPluginLayerRegistry

A registry of plugin layers types.

class QgsPluginLayerType

class for creating plugin specific layers

class QgsPoint

Point geometry type, with support for z-dimension and m-values.

class QgsPointClusterRenderer

A renderer that automatically clusters points with the same geographic position.

class QgsPointDisplacementRenderer

A renderer that automatically displaces points with the same geographic location.

class QgsPointDistanceRenderer

An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers).

class QgsPointLocator

The class defines interface for querying point location:

class QgsPointLocator_DumpTree

Helper class to dump the R-index nodes and their content.

class QgsPointLocator_Stream

Helper class for bulk loading of R-trees.

class QgsPointLocator_VisitorArea

Helper class used when traversing the index with areas - builds a list of matches.

class QgsPointLocator_VisitorEdgesInRect

Helper class used when traversing the index looking for edges - builds a list of matches.

class QgsPointLocator_VisitorNearestEdge

Helper class used when traversing the index looking for edges - builds a list of matches.

class QgsPointLocator_VisitorNearestVertex

Helper class used when traversing the index looking for vertices - builds a list of matches.

class QgsPointXY

A class to represent a 2D point.

class QgsPolygon

Polygon geometry type.

class QgsPresetSchemeColorRamp

A scheme based color ramp consisting of a list of predefined colors.

class QgsPrintLayout

Print layout, a QgsLayout subclass for static or atlas-based layouts.

class QgsProcessing

Contains enumerations and other constants for use in processing algorithms and parameters.

class QgsProcessingAlgorithm

Abstract base class for processing algorithms.

class QgsProcessingAlgRunnerTask

QgsTask task which runs a QgsProcessingAlgorithm in a background task.

class QgsProcessingContext

Contains information about the context in which a processing algorithm is executed.

class QgsProcessingDestinationParameter

Base class for all parameter definitions which represent file or layer destinations, e.g.

class QgsProcessingException

Custom exception class for processing related exceptions.

class QgsProcessingFeatureBasedAlgorithm

An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-feature".

class QgsProcessingFeatureSink

QgsProxyFeatureSink subclass which reports feature addition errors to a QgsProcessingContext.

class QgsProcessingFeatureSource

QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource, modifying results according to the settings in a QgsProcessingContext.

class QgsProcessingFeatureSourceDefinition

Encapsulates settings relating to a feature source input to a processing algorithm.

class QgsProcessingFeedback

Base class for providing feedback from a processing algorithm.

class QgsProcessingLayerPostProcessorInterface

An interface for layer post-processing handlers for execution following a processing algorithm operation.

class QgsProcessingMultiStepFeedback

Processing feedback object for multi-step operations.

class QgsProcessingOutputDefinition

Base class for the definition of processing outputs.

class QgsProcessingOutputFile

A file output for processing algorithms.

class QgsProcessingOutputFolder

A folder output for processing algorithms.

class QgsProcessingOutputHtml

A HTML file output for processing algorithms.

class QgsProcessingOutputLayerDefinition

Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.

class QgsProcessingOutputMapLayer

A map layer output for processing algorithms, where layers may be either vector or raster.

class QgsProcessingOutputMultipleLayers

A multi-layer output for processing algorithms which create map layers, when the number and nature of the output layers is not predefined.

class QgsProcessingOutputNumber

A numeric output for processing algorithms.

class QgsProcessingOutputRasterLayer

A raster layer output for processing algorithms.

class QgsProcessingOutputString

A string output for processing algorithms.

class QgsProcessingOutputVectorLayer

A vector layer output for processing algorithms.

class QgsProcessingParameterAuthConfig

A string parameter for authentication configuration configuration ID values.

class QgsProcessingParameterBand

A raster band parameter for Processing algorithms.

class QgsProcessingParameterBoolean

A boolean parameter for processing algorithms.

class QgsProcessingParameterCrs

A coordinate reference system parameter for processing algorithms.

class QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

class QgsProcessingParameterDistance

A double numeric parameter for distance values.

class QgsProcessingParameterEnum

An enum based parameter for processing algorithms, allowing for selection from predefined values.

class QgsProcessingParameterExpression

An expression parameter for processing algorithms.

class QgsProcessingParameterExtent

A rectangular map extent parameter for processing algorithms.

class QgsProcessingParameterFeatureSink

A feature sink output for processing algorithms.

class QgsProcessingParameterFeatureSource

An input feature source (such as vector layers) parameter for processing algorithms.

class QgsProcessingParameterField

A vector layer or feature source field parameter for processing algorithms.

class QgsProcessingParameterFile

An input file or folder parameter for processing algorithms.

class QgsProcessingParameterFileDestination

A generic file based destination parameter, for specifying the destination path for a file (non-map layer) created by the algorithm.

class QgsProcessingParameterFolderDestination

A folder destination parameter, for specifying the destination path for a folder created by the algorithm or used for creating new files within the algorithm.

class QgsProcessingParameterLimitedDataTypes

Can be inherited by parameters which require limits to their acceptable data types.

class QgsProcessingParameterMapLayer

A map layer parameter for processing algorithms.

class QgsProcessingParameterMatrix

A table (matrix) parameter for processing algorithms.

class QgsProcessingParameterMeshLayer

A mesh layer parameter for processing algorithms.

class QgsProcessingParameterMultipleLayers

A parameter for processing algorithms which accepts multiple map layers.

class QgsProcessingParameterNumber

A numeric parameter for processing algorithms.

class QgsProcessingParameterPoint

A point parameter for processing algorithms.

class QgsProcessingParameterRange

A numeric range parameter for processing algorithms.

class QgsProcessingParameterRasterDestination

A raster layer destination parameter, for specifying the destination path for a raster layer created by the algorithm.

class QgsProcessingParameterRasterLayer

A raster layer parameter for processing algorithms.

class QgsProcessingParameters

A collection of utilities for working with parameters when running a processing algorithm.

class QgsProcessingParameterString

A string parameter for processing algorithms.

class QgsProcessingParameterType

Makes metadata of processing parameters available.

class QgsProcessingParameterTypeAuthConfig

A authentication configuration parameter for processing algorithms.

class QgsProcessingParameterTypeBand

A raster band parameter for Processing algorithms.

class QgsProcessingParameterTypeBoolean

A boolean parameter for processing algorithms.

class QgsProcessingParameterTypeCrs

A crs parameter for processing algorithms.

class QgsProcessingParameterTypeDistance

A distance parameter for processing algorithms.

class QgsProcessingParameterTypeEnum

An enum based parameter for processing algorithms, allowing for selection from predefined values.

class QgsProcessingParameterTypeExpression

An expression parameter for processing algorithms.

class QgsProcessingParameterTypeExtent

A rectangular map extent parameter for processing algorithms.

class QgsProcessingParameterTypeFeatureSink

A feature sink parameter for Processing algorithms.

class QgsProcessingParameterTypeFeatureSource

An input feature source (such as vector layers) parameter for processing algorithms.

class QgsProcessingParameterTypeField

A vector layer or feature source field parameter for processing algorithms.

class QgsProcessingParameterTypeFile

An input file or folder parameter for processing algorithms.

class QgsProcessingParameterTypeFileDestination

A generic file based destination parameter, for specifying the destination path for a file (non-map layer) created by the algorithm.

class QgsProcessingParameterTypeFolderDestination

A folder destination parameter, for specifying the destination path for a folder created by the algorithm or used for creating new files within the algorithm.

class QgsProcessingParameterTypeMapLayer

A generic map layer parameter for processing algorithms.

class QgsProcessingParameterTypeMatrix

A table (matrix) parameter for processing algorithms.

class QgsProcessingParameterTypeMeshLayer

A mesh layer parameter for processing algorithms.

class QgsProcessingParameterTypeMultipleLayers

A parameter for processing algorithms which accepts multiple map layers.

class QgsProcessingParameterTypeNumber

A numeric parameter for processing algorithms.

class QgsProcessingParameterTypePoint

A point parameter for processing algorithms.

class QgsProcessingParameterTypeRange

A numeric range parameter for processing algorithms.

class QgsProcessingParameterTypeRasterDestination

A raster layer destination parameter, for specifying the destination path for a raster layer created by the algorithm.

class QgsProcessingParameterTypeRasterLayer

A raster layer parameter for processing algorithms.

class QgsProcessingParameterTypeString

A string parameter for processing algorithms.

class QgsProcessingParameterTypeVectorDestination

A vector layer destination parameter, for specifying the destination path for a vector layer created by the algorithm.

class QgsProcessingParameterTypeVectorLayer

A vector layer parameter for processing algorithms.

class QgsProcessingParameterVectorDestination

A vector layer destination parameter, for specifying the destination path for a vector layer created by the algorithm.

class QgsProcessingParameterVectorLayer

A vector layer (with or without geometry) parameter for processing algorithms.

class QgsProcessingProvider

Abstract base class for processing providers.

class QgsProcessingRegistry

Registry for various processing components, including providers, algorithms and various parameters and outputs.

class QgsProcessingUtils

Utility functions for use with processing classes.

class QgsProject

Reads and writes project states.

class QgsProjectArchive

Class allowing to manage the zip/unzip actions on project file.

class QgsProjectBadLayerHandler

Interface for classes that handle missing layer files when reading project file.

class QgsProjectColorScheme

A color scheme which contains project specific colors set through project properties dialog.

class QgsProjectDirtyBlocker

Temporarily blocks QgsProject "dirtying" for the lifetime of the object.

class QgsProjectItem

Data item that can be used to represent QGIS projects.

class QgsProjectMetadata

A structured metadata store for a map layer.

class QgsProjectProperty

An Abstract Base Class for QGIS project property hierarchys.

class QgsProjectPropertyKey

Project property key node.

class QgsProjectPropertyValue

Project property value node, contains a QgsProjectPropertyKey's value.

class QgsProjectStorage

Abstract interface for project storage - to be implemented by various backends and registered in QgsProjectStorageRegistry.

class QgsProjectStorageRegistry

Registry of storage backends that QgsProject may use.

class QgsProjectTranslator

Wherever an object of this class is available, the derived translate function can be called from.

class QgsProjectVersion

A class to describe the version of a project.

class QgsProperty

A store for object properties.

class QgsPropertyCollection

A grouped map of multiple QgsProperty objects, each referenced by a integer key value.

class QgsPropertyCollectionStack

An ordered stack of QgsPropertyCollection containers, where collections added later to the stack will take priority over earlier collections.

class QgsPropertyDefinition

Definition for a property.

class QgsPropertyTransformer

Abstract base class for objects which transform the calculated value of a property.

class QgsProviderMetadata

Holds data provider key, description, and associated shared library file or function pointer information.

class QgsProviderRegistry

A registry / canonical manager of data providers.

class QgsProxyFeatureSink

A simple feature sink which proxies feature addition on to another feature sink.

class QgsProxyProgressTask

A QgsTask shell which proxies progress reports.

class QgsPythonRunner

Utility class for running Python commands from various parts of QGIS.

class QgsQtLocationConnection

class QgsQuadrilateral

Quadrilateral geometry type.

class QgsRandomColorRamp

Totally random color ramp.

template<typename T>

class QgsRange

A template based class for storing ranges (lower to upper values).

class QgsRangeFieldFormatter

Field formatter for a range (double) field with precision and locale.

class QgsRaster

Raster namespace.

class QgsRasterBandStats

The RasterBandStats struct is a container for statistics about a single raster band.

class QgsRasterBlock

Raster data container.

class QgsRasterBlockFeedback

Feedback object tailored for raster block reading.

class QgsRasterChecker

This is a helper class for unit tests that need to write an image and compare it to an expected result or render time.

class QgsRasterDataProvider

Base class for raster data providers.

class QgsRasterDrawer

The drawing pipe for raster layers.

class QgsRasterFileWriter

The raster file writer which allows you to save a raster to a new file.

class QgsRasterFileWriterTask

QgsTask task which performs a QgsRasterFileWriter layer saving operation as a background task.

class QgsRasterFillSymbolLayer

A class for filling symbols with a repeated raster image.

class QgsRasterHistogram

The QgsRasterHistogram is a container for histogram of a single raster band.

class QgsRasterIdentifyResult

Raster identify results container.

class QgsRasterInterface

Base class for processing filters like renderers, reprojector, resampler etc.

class QgsRasterIterator

Iterator for sequentially processing raster cells.

class QgsRasterLayer

This class provides qgis with the ability to render raster datasets onto the mapcanvas.

class QgsRasterLayerRenderer

Implementation of threaded rendering for raster layers.

class QgsRasterMarkerSymbolLayer

Raster marker symbol layer class.

class QgsRasterMinMaxOrigin

This class describes the origin of min/max values.

class QgsRasterNuller

Raster pipe that deals with null values.

class QgsRasterPipe

Base class for processing modules.

class QgsRasterProjector

QgsRasterProjector implements approximate projection support for it calculates grid of points in source CRS for target CRS + extent which are used to calculate affine transformation matrices.

class QgsRasterPyramid

This struct is used to store pyramid info for the raster layer.

class QgsRasterRange

Raster values range container.

class QgsRasterRenderer

Raster renderer pipe that applies colors to a raster.

class QgsRasterRendererRegistry

Registry for raster renderers.

struct QgsRasterRendererRegistryEntry

Registry for raster renderer entries.

class QgsRasterResampleFilter

Resample filter pipe for rasters.

class QgsRasterResampler

Interface for resampling rasters (e.g.

class QgsRasterShader

Interface for all raster shaders.

class QgsRasterShaderFunction

The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color.

class QgsRasterSymbolLegendNode

Implementation of legend node interface for displaying raster legend entries.

class QgsRasterTransparency

Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters.

struct QgsRasterViewPort

This class provides details of the viewable area that a raster will be rendered into.

class QgsRay2D

A 2D ray which extends from an origin point to an infinite distance in a given direction.

class QgsReadWriteContext

The class is used as a container of context for various read/write operations on other objects.

class QgsReadWriteContextCategoryPopper

Allows entering a context category and takes care of leaving this category on deletion of the class.

class QgsReadWriteLocker

The QgsReadWriteLocker class is a convenience class that simplifies locking and unlocking QReadWriteLocks.

class QgsRecentColorScheme

A color scheme which contains the most recently used colors.

class QgsRectangle

A rectangle specified with double values.

class QgsReferencedGeometryBase

A base class for geometry primitives which are stored with an associated reference system.

class QgsReferencedPointXY

A QgsPointXY with associated coordinate reference system.

class QgsReferencedRectangle

A QgsRectangle with associated coordinate reference system.

class QgsRegularPolygon

Regular Polygon geometry type.

class QgsRelationManager

This class manages a set of relations between layers.

class QgsRelationReferenceFieldFormatter

Field formatter for a relation reference field.

class QgsRenderChecker

This is a helper class for unit tests that need to write an image and compare it to an expected result or render time.

class QgsRenderContext

Contains information about the context of a rendering operation.

class QgsRendererAbstractMetadata

Stores metadata about one renderer class.

class QgsRendererCategory

Represents an individual category (class) from a QgsCategorizedSymbolRenderer.

class QgsRendererMetadata

Convenience metadata class that uses static functions to create renderer and its widget.

class QgsRendererRangeLabelFormat

class QgsRendererRegistry

Registry of renderers.

class QgsRuleBasedLabeling

class QgsRuleBasedLabelProvider

class QgsRuleBasedRenderer

When drawing a vector layer with rule-based renderer, it goes through the rules and draws features with symbols from rules that match.

class QgsRunProcess

A class that executes an external program/script.

class QgsScaleBarRenderer

Abstract base class for scale bar renderers.

class QgsScaleBarSettings

The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.

class QgsScaleCalculator

Calculates scale for a given combination of canvas size, map extent, and monitor dpi.

class QgsScopedExpressionFunction

Expression function for use within a QgsExpressionContextScope.

class QgsScopedProxyProgressTask

Scoped QgsScopedProxyProgressTask, which automatically adds the proxy task to the application task manager on construction and finalizes the task when it goes out of scope.

class QgsSettings

This class is a composition of two QSettings instances:

class QgsShadowEffect

Base class for paint effects which offset, blurred shadows.

template<class Object>

class QgsSignalBlocker

RAII signal blocking class.

class QgsSimpleLegendNode

Implementation of legend node interface for displaying arbitrary label with icon.

class QgsSimpleMarkerSymbolLayer

Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke.

class QgsSimpleMarkerSymbolLayerBase

Abstract base class for simple marker symbol layers.

class QgsSimplifyMethod

This class contains information about how to simplify geometries fetched from a QgsFeatureIterator.

class QgsSingleBandColorDataRenderer

Raster renderer pipe for single band color.

class QgsSingleBandGrayRenderer

Raster renderer pipe for single band gray.

class QgsSingleBandPseudoColorRenderer

Raster renderer pipe for single band pseudocolor.

class QgsSingleBoxScaleBarRenderer

Scalebar style that draws a single box with alternating color for the segments.

class QgsSingleCategoryDiagramRenderer

Renders the diagrams for all features with the same settings.

class QgsSizeScaleTransformer

QgsPropertyTransformer subclass for scaling a value into a size according to various scaling methods.

class QgsSnappingConfig

This is a container for configuration of the snapping of the project.

class QgsSnappingUtils

This class has all the configuration of snapping and can return answers to snapping queries.

class QgsSpatialIndex

A spatial index for QgsFeature objects.

class QgsSpatialIndexCopyVisitor

class QgsSpatialIndexData

Data of spatial index that may be implicitly shared.

class QgsSpatialIndexKDBush

A very fast static spatial index for 2D points based on a flat KD-tree.

class QgsSpatialIndexKDBushData

A container for data stored inside a QgsSpatialIndexKDBush index.

struct QgsSpatialiteCloser

Closes a spatialite database.

class QgsSqlExpressionCompiler

Generic expression compiler for translation to provider specific SQL WHERE clauses.

struct QgsSqlite3Closer

Closes a sqlite3 database.

class QgsSqliteUtils

Contains utilities for working with Sqlite data sources.

class QgsSQLStatement

Class for parsing SQL statements.

class QgsSQLStatementCollectTableNames

Internal use.

class QgsStaticExpressionFunction

c++ helper class for defining QgsExpression functions.

class QgsStatisticalSummary

Calculator for summary statistics for a list of doubles.

class QgsStringReplacement

A representation of a single string replacement.

class QgsStringReplacementCollection

A collection of string replacements (specified using QgsStringReplacement objects).

class QgsStringStatisticalSummary

Calculator for summary statistics and aggregates for a list of strings.

class QgsStringUtils

Utility functions for working with strings.

class QgsStyleModel

A QAbstractItemModel subclass for showing symbol and color ramp entities contained within a QgsStyle database.

class QgsStyleProxyModel

A QSortFilterProxyModel subclass for showing filtered symbol and color ramps entries from a QgsStyle database.

class QgsSvgAnnotation

An annotation which renders the contents of an SVG file.

class QgsSvgCache

A cache for images / pictures derived from svg files.

class QgsSVGFillSymbolLayer

A class for filling symbols with a repeated SVG file.

class QgsSymbol

Abstract base class for all rendered symbols.

class QgsSymbolLayerAbstractMetadata

Stores metadata about one symbol layer class.

class QgsSymbolLayerMetadata

Convenience metadata class that uses static functions to create symbol layer and its widget.

class QgsSymbolLayerRegistry

Registry of available symbol layer classes.

class QgsSymbolLegendNode

Implementation of legend node interface for displaying preview of vector symbols and their labels and allowing interaction with the symbol / renderer.

class QgsTask

Abstract base class for long running background tasks.

class QgsTaskManager

Task manager for managing a set of long-running QgsTask tasks.

template<typename T>

class QgsTemporalRange

A template based class for storing temporal ranges (beginning to end values).

class QgsTessellator

Class that takes care of tessellation of polygons into triangles.

class QgsTextAnnotation

An annotation item that displays formatted text from a QTextDocument document.

class QgsTextBackgroundSettings

Container for settings relating to a text background object.

class QgsTextBufferSettings

Container for settings relating to a text buffer.

class QgsTextFormat

Container for all settings relating to text rendering.

class QgsTextLabelFeature

Class that adds extra information to QgsLabelFeature for text labels.

class QgsTextRenderer

Handles rendering text using rich formatting options, including drop shadows, buffers and background shapes.

class QgsTextShadowSettings

Container for settings relating to a text shadow.

class QgsThreadingUtils

Provides threading utilities for QGIS.

class QgsTicksScaleBarRenderer

A scale bar that draws segments using short ticks.

class QgsTolerance

This is the class is providing tolerance value in map unit values.

class QgsTopologyPreservingSimplifier

Implementation of GeometrySimplifier using the Douglas-Peucker algorithm.

class QgsTracer

Utility class that construct a planar graph from the input vector layers and provides shortest path search for tracing of existing features.

class QgsTransaction

This class allows including a set of layers in a database-side transaction, provided the layer data providers support transactions and are compatible with each other.

class QgsTransformEffect

A paint effect which applies transformations (such as move, scale and rotate) to a picture.

class QgsTranslationContext

Used for the collecting of strings from projects for translation and creation of ts files.

class QgsTriangle

Triangle geometry type.

class QgsTriangularMesh

Triangular/Derived Mesh is mesh with vertices in map coordinates.

class QgsUnitTypes

Helper functions for various unit types.

class QgsUserColorScheme

A color scheme which stores its colors in a gpl palette file within the "palettes" subfolder off the user's QGIS settings folder.

class QgsUserProfile

User profile contains information about the user profile folders on the machine.

class QgsUserProfileManager

User profile manager is used to manager list, and manage user profiles on the users machine.

class QgsValidityCheckContext

Base class for validity check contexts.

class QgsValidityCheckResult

Represents an individual result from a validity check run by a QgsAbstractValidityCheck subclass.

class QgsValueMapFieldFormatter

Field formatter for a ValueMap field.

class QgsValueRelationFieldFormatter

Field formatter for a value relation field.

class QgsVector

A class to represent a vector.

class QgsVectorDataProvider

This is the base class for vector data providers.

class QgsVectorFieldSymbolLayer

A symbol layer class for displaying displacement arrows based on point layer attributes.

class QgsVectorFileWriter

A convenience class for writing vector files to disk.

class QgsVectorFileWriterTask

QgsTask task which performs a QgsVectorFileWriter layer saving operation as a background task.

class QgsVectorLayer

Represents a vector layer which manages a vector based data sets.

class QgsVectorLayer3DRenderer

3D renderer that renders all features of a vector layer with the same 3D symbol.

class QgsVectorLayer3DRendererMetadata

Metadata for vector layer 3D renderer to allow creation of its instances from XML.

class QgsVectorLayerCache

This class caches features of a given QgsVectorLayer.

class QgsVectorLayerDiagramProvider

The QgsVectorLayerDiagramProvider class implements support for diagrams within the labeling engine.

class QgsVectorLayerExporter

A convenience class for exporting vector layers to a destination data provider.

class QgsVectorLayerExporterTask

QgsTask task which performs a QgsVectorLayerExporter layer export operation as a background task.

class QgsVectorLayerFeatureCounter

Counts the features in a QgsVectorLayer in task.

class QgsVectorLayerFeatureSource

Partial snapshot of vector layer's state (only the members necessary for access to features)

class QgsVectorLayerJoinBuffer

Manages joined fields for a vector layer.

class QgsVectorLayerJoinInfo

Defines left outer join from our vector layer to some other vector layer.

class QgsVectorLayerLabelProvider

The QgsVectorLayerLabelProvider class implements a label provider for vector layers.

class QgsVectorLayerRenderer

Implementation of threaded rendering for vector layers.

class QgsVectorLayerRendererInterruptionChecker

Interruption checker used by QgsVectorLayerRenderer::render()

class QgsVectorLayerSelectedFeatureSource

QgsFeatureSource subclass for the selected features from a QgsVectorLayer.

class QgsVectorLayerSimpleLabeling

Basic implementation of the labeling interface.

class QgsVectorLayerTools

Methods in this class are used to handle basic operations on vector layers.

class QgsVectorLayerUndoCommand

Base class for undo commands within a QgsVectorLayerEditBuffer.

class QgsVectorLayerUndoCommandAddAttribute

Undo command for adding a new attribute to a vector layer.

class QgsVectorLayerUndoCommandAddFeature

Undo command for adding a feature to a vector layer.

class QgsVectorLayerUndoCommandChangeAttribute

Undo command for modifying an attribute of a feature from a vector layer.

class QgsVectorLayerUndoCommandChangeGeometry

Undo command for modifying the geometry of a feature from a vector layer.

class QgsVectorLayerUndoCommandDeleteAttribute

Undo command for removing an existing attribute from a vector layer.

class QgsVectorLayerUndoCommandDeleteFeature

Undo command for deleting a feature from a vector layer.

class QgsVectorLayerUndoCommandRenameAttribute

Undo command for renaming an existing attribute of a vector layer.

class QgsVectorLayerUndoPassthroughCommand

Undo command for vector layer in transaction group mode.

class QgsVectorLayerUndoPassthroughCommandAddAttribute

Undo command for adding attri to a vector layer in transaction group.

class QgsVectorLayerUndoPassthroughCommandAddFeatures

Undo command for adding a feature to a vector layer in transaction group mode.

class QgsVectorLayerUndoPassthroughCommandChangeAttribute

Undo command for changing attr value from a vector layer in transaction group.

class QgsVectorLayerUndoPassthroughCommandChangeAttributes

Undo command for changing attributes' values from a vector layer in transaction group.

class QgsVectorLayerUndoPassthroughCommandChangeGeometry

Undo command for changing feature geometry from a vector layer in transaction group.

class QgsVectorLayerUndoPassthroughCommandDeleteAttribute

Undo command for deleting attri of a vector layer in transaction group.

class QgsVectorLayerUndoPassthroughCommandDeleteFeatures

Undo command for deleting features from a vector layer in transaction group.

class QgsVectorLayerUndoPassthroughCommandRenameAttribute

Undo command for deleting attri of a vector layer in transaction group.

class QgsVectorLayerUndoPassthroughCommandUpdate

Undo command for running a specific sql query in transaction group.

class QgsVectorLayerUtils

Contains utility methods for working with QgsVectorLayers.

class QgsVectorSimplifyMethod

This class contains information how to simplify geometries fetched from a vector layer.

class QgsVertexId

Utility class for identifying a unique vertex within a geometry.

class QgsVertexIterator

Java-style iterator for traversal of vertices of a geometry.

class QgsVirtualLayerDefinition

Class to manipulate the definition of a virtual layer.

class QgsVirtualLayerDefinitionUtils

Utils class for QgsVirtualLayerDefinition.

class QgsVirtualLayerTask

Initializes a virtual layer with postpone mode activated and reloads the data in a separated thread.

class QgsWebPage

QWebPage subclass which redirects JavaScript errors and console output to the QGIS message log.

class QgsWebView

The QgsWebView class is a collection of stubs to mimic the API of QWebView on systems where the real library is not available.

class QgsWithVariableExpressionFunction

Handles the with_variable(name, value, node) expression function.

class QgsWkbException

Custom exception class for Wkb related exceptions.

class QgsWkbTypes

Handles storage of information regarding WKB types and their properties.

class QgsWmsLegendNode

Implementation of legend node interface for displaying WMS legend entries.

class QgsXmlUtils

Assorted helper methods for reading and writing chunks of XML.

class QgsZipItem

A zip file: contains layers, using GDAL/OGR VSIFILE mechanism.

class QWebFrame

The QWebFrame class is a collection of stubs to mimic the API of a QWebFrame on systems where QtWebkit is not available.

class QWebPage

The QWebPage class is a collection of stubs to mimic the API of a QWebPage on systems where QtWebkit is not available.

class QWebSettings

The QWebSettings class is a collection of stubs to mimic the API of a QWebSettings on systems where QtWebkit is not available.

class QgsSQLStatement::RecursiveVisitor

A visitor that recursively explores all children.

struct QgsRuleBasedRenderer::RenderJob

A QgsRuleBasedRenderer rendering job, consisting of a feature to be rendered with a particular symbol.

struct QgsRuleBasedRenderer::RenderLevel

Render level: a list of jobs to be drawn at particular level for a QgsRuleBasedRenderer.

class QgsRuleBasedLabeling::Rule

class QgsRuleBasedRenderer::Rule

This class keeps data about a rules for rule-based renderer.

class QgsVectorFileWriter::SaveVectorOptions

Options to pass to writeAsVectorFormat()

class pal::Sol

class QgsVirtualLayerDefinition::SourceLayer

A SourceLayer is either a reference to a live layer in the registry or all the parameters needed to load it (provider key, source, etc.)

class spatialite_database_unique_ptr

Unique pointer for spatialite databases, which automatically closes the database when the pointer goes out of scope or is reset.

class sqlite3_database_unique_ptr

Unique pointer for sqlite3 databases, which automatically closes the database when the pointer goes out of scope or is reset.

class sqlite3_statement_unique_ptr

Unique pointer for sqlite3 prepared statements, which automatically finalizes the statement when the pointer goes out of scope or is reset.

class pal::PalException::UnknownFeature

Try to access an unknown feature.

class pal::InternalException::UnknownGeometry

Thrown when a geometry type is not like expected.

class pal::PalException::UnknownLayer

Try to access an unknown layer.

class pal::Util

class pal::PalException::ValueNotInRange

thrown when a value is not in the valid scale range\

class QgsAbstractGeometry::vertex_iterator

The vertex_iterator class provides STL-style iterator for vertices.

class QgsSQLStatement::Visitor

Support for visitor pattern - algorithms dealing with the statement may be implemented without modifying the Node classes.

class QgsExpressionNodeCondition::WhenThen

Represents a "WHEN... THEN..." portation of a CASE WHEN clause in an expression.

class pal::InternalException::WrongGeometry

Thrown when a geometry type is not like expected.

Typedefs

using ContactList = QList<QgsAbstractMetadataBase::Contact>

A list of contacts.

using LinkList = QList<QgsAbstractMetadataBase::Link>

A list of links.

using QgsLayoutTableColumns = QVector<QgsLayoutTableColumn*>

List of column definitions for a QgsLayoutTable.

using QgsLayoutTableContents = QVector<QgsLayoutTableRow>

List of QgsLayoutTableRows, representing rows and column cell contents for a QgsLayoutTable.

using QgsLayoutTableRow = QVector<QVariant>

List of QVariants, representing a the contents of a single row in a QgsComposerTable.

using QgsNamedColorList = QList<QPair<QColor, QString>>

List of colors paired with a friendly display name identifying the color.

using QgsSmartConditionMap = QMultiMap<QString, QString>

A multimap to hold the smart group conditions as constraint and parameter pairs.

Typedef documentation