QGIS API Documentation  2.0.1-Dufour
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oNQgisGui/namespace QgisGui The QgisGui namespace contains constants and helper functions used throughout the QGIS GUI
oC_nmeaGPGGAGGA packet information structure (Global Positioning System Fix Data)
oC_nmeaGPGSAGSA packet information structure (Satellite status)
oC_nmeaGPGSVGSV packet information structure (Satellites in view)
oC_nmeaGPRMCRMC packet information structure (Recommended Minimum sentence C)
oC_nmeaGPVTGVTG packet information structure (Track made good and ground speed)
oC_nmeaINFOSummary GPS information from all parsed packets, used also for generating NMEA stream
oC_nmeaPOSPosition data in fractional degrees or radians
oC_nmeaSATELLITEInformation about satellite
oC_nmeaSATINFOInformation about all satellites in view
oC_nmeaTIMEDate and time data
oCBezier3DClass Bezier3D represents a bezier curve, represented by control points
oCCloughTocherInterpolatorThis is an implementation of a Clough-Tocher interpolator based on a triangular tessellation
oCDualEdgeTriangulationDualEdgeTriangulation is an implementation of a triangulation class based on the dual edge data structure
oCLine3DThis class represents a line
oCLinTriangleInterpolatorLinTriangleInterpolator is a class which interpolates linearly on a triangulation
oCNodeNode is a class used by Line3D
oCNormVecDecoratorDecorator class which adds the functionality of estimating normals at the data points
oCParametricLineParametricLine is an Interface for parametric lines
oCPoint3DPoint3D is a class to represent a three dimensional point
oCQGisGlobal constants for use throughout the application
oCQgisInterfaceQgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugins
oCQgisPluginAbstract base class from which all plugins must inherit
oCQgsAbstractCacheIndexAbstract base class for cache indices
oCQgsAbstractFeatureIteratorInternal feature iterator to be implemented within data providers
oCQgsActionUtility class that encapsulates an action based on vector attributes
oCQgsAddRemoveItemCommandA composer command class for adding / removing composer items
oCQgsAnnotationItemAn annotation item can be either placed either on screen corrdinates or on map coordinates
oCQgsApplicationExtends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc
oCQgsApplyDialogInterface class for dialogs that have an apply operation (e.g
oCQgsAspectFilterCalculates aspect values in a window of 3x3 cells based on first order derivatives in x- and y- directions
oCQgsAtlasCompositionClass used to render an Atlas, iterating over geometry features
oCQgsAttributeActionStorage and management of actions associated with Qgis layer attributes
oCQgsAttributeTableDelegateA delegate item class for QgsAttributeTable (see Qt documentation for QItemDelegate)
oCQgsAttributeTableModelA model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a QAbstractItemView
oCQgsAttributeTableViewProvides a table view of features of a QgsVectorLayer
oCQgsBilinearRasterResamplerBilinear Raster Resampler
oCQgsBlendModeComboBoxA combobox which lets the user select blend modes from a predefined list
oCQgsBrightnessContrastFilterBrightness/contrast filter pipe for rasters
oCQgsBusyIndicatorDialogA simple dialog to show an indeterminate busy progress indicator
oCQgsCachedFeatureIteratorDelivers features from the cache
oCQgsCachedFeatureWriterIteratorUses another iterator as backend and writes features to the cache
oCQgsCharacterSelectorDialogA dialog for selecting a single character from a single font
oCQgsClipperA class to trim lines and polygons to within a rectangular region
oCQgsClipToMinMaxEnhancementA raster contrast enhancement that will clip a value to the specified min/max range
oCQgsCollapsibleGroupBoxA groupbox that collapses/expands when toggled and can save its collapsed and checked states
oCQgsCollapsibleGroupBoxBasicA groupbox that collapses/expands when toggled
oCQgsColorButtonA cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog
oCQgsColorDialogA dialog for selecting a color
oCQgsColorRampShaderA ramp shader will color a raster pixel based on a list of values ranges in a ramp
oCQgsComposerArrowAn item that draws an arrow between to points
oCQgsComposerAttributeTableA table class that displays a vector attribute table
oCQgsComposerAttributeTableCompareHelper class for sorting, takes into account sorting column and ascending / descending
oCQgsComposerFrameFrame for html, table, text which can be divided onto several frames
oCQgsComposerItemA item that forms part of a map composition
oCQgsComposerItemCommandUndo command to undo/redo all composer item related changes
oCQgsComposerItemGroupA container for grouping several QgsComposerItems
oCQgsComposerLabelA label that can be placed onto a map composition
oCQgsComposerLegendA legend that can be placed onto a map composition
oCQgsComposerLegendItemAbstract base class for the legend item types
oCQgsComposerLegendStyleComposer legend components style
oCQgsComposerMapObject representing map window
oCQgsComposerMergeCommandA composer command that merges together with other commands having the same context (=id)
oCQgsComposerMultiFrameAbstract base class for composer entries with the ability to distribute the content to several frames (items)
oCQgsComposerPictureA composer class that displays svg files or raster format (jpg, png, ...)
oCQgsComposerRulerA class to show paper scale and the current cursor position
oCQgsComposerScaleBarA scale bar item that can be added to a map composition
oCQgsComposerShapeA composer items that draws common shapes (ellipse, triangle, rectangle)
oCQgsComposerTableA class to display feature attributes in the print composer
oCQgsComposerTextTableA text table item that reads text from string lists
oCQgsComposerViewWidget to display the composer items
oCQgsCompositionGraphics scene for map printing
oCQgsContextHelpProvides a context based help browser for a dialog
oCQgsContrastEnhancementManipulates raster pixel values so that they enhanceContrast or clip into a specified numerical range according to the specified ContrastEnhancementAlgorithm
oCQgsContrastEnhancementFunctionA contrast enhancement funcion is the base class for all raster contrast enhancements
oCQgsCoordinateReferenceSystemClass for storing a coordinate reference system (CRS)
oCQgsCoordinateTransformClass for doing transforms between two map coordinate systems
oCQgsCoordinateTransformCacheCache coordinate transform by authid of source/dest transformation to avoid the overhead of initialisation for each redraw
oCQgsCptCityAllRampsItemAn "All ramps item", which contains all items in a flat hierarchy
oCQgsCptCityCollectionItemA Collection: logical collection of subcollections and color ramps
oCQgsCptCityColorRampItemItem that represents a layer that can be opened with one of the providers
oCQgsCptCityDataItemBase class for all items in the model
oCQgsCptCityDirectoryItemA directory: contains subdirectories and color ramps
oCQgsCptCitySelectionItemA selection: contains subdirectories and color ramps
oCQgsCredentialDialogA generic dialog for requesting credentials
oCQgsCredentialsInterface for requesting credentials in QGIS in GUI independent way
oCQgsCredentialsConsoleDefault implementation of credentials interface
oCQgsCsExceptionCustom exception class for Coordinate Reference System related exceptions
oCQgsCubicRasterResamplerCubic Raster Resampler
oCQgsDataCollectionItemA Collection: logical collection of layers or subcollections, e.g
oCQgsDataDefinedA container class for data source field mapping or expression
oCQgsDataDefinedButtonA button for defining data source field mappings or expressions
oCQgsDataItemBase class for all items in the model
oCQgsDataProviderAbstract base class for spatial data provider implementations
oCQgsDataSourceURIClass for storing the component parts of a PostgreSQL/RDBMS datasource URI
oCQgsDbFilterProxyModelA class that implements a custom filter and can be used as a proxy for QgsDbTableModel
oCQgsDerivativeFilterAdds the ability to calculate derivatives in x- and y-directions
oCQgsDetailedItemDataThis class is the data only representation of a QgsDetailedItemWidget, designed to be used in custom views
oCQgsDetailedItemDelegateA custom model/view delegate that can display an icon, heading and detail sections
oCQgsDetailedItemWidgetA widget renderer for detailed item views
oCQgsDiagramRendererV2Returns diagram settings for a feature
oCQgsDialogA generic dialog with layout and button box
oCQgsDirectoryItemA directory: contains subdirectories and layers
oCQgsDistanceAreaGeneral purpose distance and area calculator
oCQgsDoubleBoxScaleBarStyleDouble box with alternating colors
oCQgsDualViewThis widget is used to show the attributes of a set of features of a QgsVectorLayer
oCQgsEllipseSymbolLayerV2A symbol layer for rendering objects with major and minor axis (e.g
oCQgsEncodingFileDialogA file dialog which lets the user select the preferred encoding type for a data provider
oCQgsErrorQgsError is container for error messages (report)
oCQgsErrorItemData item that can be used to report problems (e.g
oCQgsErrorMessageQgsErrorMessage represents single error message
oCQgsExceptionDefines a qgis exception class
oCQgsExpressionClass for parsing and evaluation of expressions (formerly called "search strings")
oCQgsExpressionBuilderDialogA generic dialog for building expression strings
oCQgsExpressionBuilderWidgetA reusable widget that can be used to build a expression string
oCQgsExpressionItemAn expression item that can be used in the QgsExpressionBuilderWidget tree
oCQgsExpressionItemSearchProxySearch proxy used to filter the QgsExpressionBuilderWidget tree
oCQgsExpressionSelectionDialogThis class offers a dialog to change feature selections
oCQgsFavouritesItemContains various Favourites directories
oCQgsFeatureThe feature class encapsulates a single feature including its id, geometry and a list of field/values attributes
oCQgsFeatureIteratorWrapper for iterator of features from vector data provider or vector layer
oCQgsFeatureListViewShows a list of features and renders a edit button next to each feature
oCQgsFeatureRequestThis class wraps a request for features to a vector layer (or directly its vector data provider)
oCQgsFeatureStoreContainer for features with the same fields and crs
oCQgsFieldEncapsulate a field in an attribute table or data source
oCQgsFieldsContainer of fields for a vector layer
oCQgsFileDropEditA line edit for capturing file names that can have files dropped onto it via drag & drop
oCQgsFilterLineEditLineedit with builtin clear button
oCQgsFormAnnotationItemAn annotation item that embedds a designer form showing the feature attribute
oCQgsGenericProjectionSelectorA generic dialog to prompt the user for a Coordinate Reference System
oCQgsGeometryA geometry is the spatial representation of a feature
oCQgsGeometryAnalyzerThe QGis class provides vector geometry analysis functions
oCQgsGmlThis class reads data from a WFS server or alternatively from a GML file
oCQgsGPSConnectionAbstract base class for connection to a GPS device
oCQgsGPSConnectionRegistryA singleton class to register / unregister existing GPS connections such that the information is available to all classes and plugins
oCQgsGpsdConnectionEvaluates NMEA sentences coming from gpsd
oCQgsGridFileWriterA class that does interpolation to a grid and writes the results to an ascii grid
oCQgsHighlightA class for highlight features on the map
oCQgsHtmlAnnotationItemAn annotation item that embedds a designer form showing the feature attribute
oCQgsHttpTransactionHTTP request/response manager that is redirect-aware
oCQgsHueSaturationFilterColor and saturation filter pipe for rasters
oCQgsImageFillSymbolLayerBase class for polygon renderers generating texture images
oCQgsInterpolatorInterface class for interpolations
oCQgsLabelA class to render labels
oCQgsLabelAttributesA class to store attributes needed for label rendering
oCQgsLabelComponentMaintains current state of more grainular and temporal values when creating/painting component parts of an individual label (e.g
oCQgsLabelingEngineInterfaceLabeling engine interface
oCQgsLabelSearchTreeA class to query the labeling structure at a given point (small wraper around pal RTree class)
oCQgsLayerItemItem that represents a layer that can be opened with one of the providers
oCQgsLegendInterfaceQgsLegendInterface Abstract base class to make QgsLegend available to plugins
oCQgsLegendModelA model that provides group, layer and classification items
oCQgsLinearMinMaxEnhancementA color enhancement function that performs a linear enhanceContrast between min and max
oCQgsLinearMinMaxEnhancementWithClipA linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max
oCQgsLoggerQgsLogger is a class to print debug/warning/error messages to the console
oCQgsMapCanvasMap canvas is a class for displaying all GIS data types on a canvas
oCQgsMapCanvasItemAn abstract class for items that can be placed on the map canvas
oCQgsMapCanvasLayerA class that stores visibility and presence in overview flags together with pointer to the layer
oCQgsMapCanvasMapA rectangular graphics item representing the map on the canvas
oCQgsMapCanvasSnapperThis class reads the snapping properties from the current project and configures a QgsSnapper to perform the snapping
oCQgsMapLayerBase class for all map layer types
oCQgsMapLayerRegistryThis class tracks map layers that are currently loaded and provides a means to fetch a pointer to a map layer and delete it
oCQgsMapOverviewCanvasA widget that displays an overview map
oCQgsMapRendererA non GUI class for rendering a map layer set onto a QPainter
oCQgsMapTipA maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature
oCQgsMapToolAbstract base class for all map tools
oCQgsMapToolEmitPointA map tool that simply emits a point when clicking on the map
oCQgsMapToolIdentifyMap tool for identifying features in layers
oCQgsMapToolPanA map tool for panning the map
oCQgsMapToolTouchA map tool for panning the map
oCQgsMapToolZoomA map tool for zooming into the map
oCQgsMapToPixelPerform transforms between map coordinates and device coordinates
oCQgsMessageBarA bar for displaying non-blocking messages to the user
oCQgsMessageLogInterface for logging messages from QGIS in GUI independent way
oCQgsMessageLogConsoleDefault implementation of message logging interface
oCQgsMessageLogViewerA generic message for displaying QGIS log messages
oCQgsMessageOutputInterface for showing messages from QGIS in GUI independent way
oCQgsMessageOutputConsoleDefault implementation of message output interface
oCQgsMessageViewerA generic message view for displaying QGIS messages
oCQgsMultiBandColorRendererRenderer for multiband images with the color components
oCQgsNetworkReplyParserMultipart QNetworkReply parser
oCQgsNewHttpConnectionDialog to allow the user to configure and save connection information for an HTTP Server for WMS, etc
oCQgsNineCellFilterBase class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on the cell value and the eight neighbour cells
oCQgsNMEAConnectionEvaluates NMEA sentences coming from a GPS device
oCQgsNumericScaleBarStyleA scale bar style that draws text in the form of '1:XXXXX'
oCQgsNumericSortTreeWidgetItemQTreeWidgetItem that can sort numerically (as opposed to just lexigraphically)
oCQgsOgcUtilsVarious utility functions for conversion between OGC (Open Geospatial Consortium) standards and QGIS internal representations
oCQgsOptionsDialogBaseA base dialog for options and properties dialogs that offers vertical tabs
oCQgsOverlayAnalyzerThe QGis class provides vector overlay analysis functions
oCQgsOWSConnectionConnections management
oCQgsOWSSourceSelectDialog to create connections and add layers from WMS, WFS, WCS etc
oCQgsPalettedRasterRendererRenderer for paletted raster images
oCQgsPanningWidgetWidget that serves as rectangle showing current extent in overview
oCQgsPaperItemItem representing the paper
oCQgsPluginLayerBase class for plugin layers
oCQgsPluginLayerRegistryRegistry of plugin layers types
oCQgsPluginLayerTypeClass for creating plugin specific layers
oCQgsPointA class to represent a point geometry
oCQgsPointDisplacementRendererA renderer that automatically displaces points with the same position
oCQgsProjectReads and writes project states
oCQgsProjectBadLayerDefaultHandlerDefault bad layer handler which ignores any missing layers
oCQgsProjectBadLayerGuiHandlerHandler for missing layers within project
oCQgsProjectBadLayerHandlerInterface for classes that handle missing layer files when reading project file
oCQgsProjectionSelectorA widget for selecting a Coordinate reference system from a tree
oCQgsProjectVersionA class to describe the version of a project
oCQgsPropertyAn Abstract Base Class for QGIS project property hierarchies
oCQgsPropertyKeyQgsPropertyKey node
oCQgsPropertyValueQgsPropertyValue node
oCQgsProviderCountCalcEventA custom event that is designed to be fired when a layer count has been fully calculated
oCQgsProviderExtentCalcEventA custom event that is designed to be fired when a layer extent has been fully calculated
oCQgsProviderMetadataHolds data provider key, description, and associated shared library file information
oCQgsProviderRegistryA registry / canonical manager of data providers
oCQgsPseudoColorShaderA raster color shader that highlighs low values in blue and high values in red
oCQgsPythonRunnerUtility class for running python commands from various parts of QGIS
oCQgsQueryBuilderQuery Builder for layers
oCQgsRasterRaster namespace
oCQgsRasterBandStatsThe RasterBandStats struct is a container for statistics about a single raster band
oCQgsRasterBlockRaster data container
oCQgsRasterCalculatorRaster calculator class
oCQgsRasterCheckerThis is a helper class for unit tests that need to write an image and compare it to an expected result or render time
oCQgsRasterDataProviderBase class for raster data providers
oCQgsRasterDrawerThe drawing pipe for raster layers
oCQgsRasterFileWriterThe raster file writer which allows you to save a raster to a new file
oCQgsRasterFormatSaveOptionsWidgetA widget to select format-specific raster saving options
oCQgsRasterHistogramThe QgsRasterHistogram is a container for histogram of a single raster band
oCQgsRasterHistogramWidgetHistogram widget
oCQgsRasterIdentifyResultRaster identify results container
oCQgsRasterInterfaceBase class for processing filters like renderers, reprojector, resampler etc
oCQgsRasterIteratorIterator for sequentially processing raster cells
oCQgsRasterLayerThis class provides qgis with the ability to render raster datasets onto the mapcanvas
oCQgsRasterNullerRaster pipe that deals with null values
oCQgsRasterPipeBase class for processing modules
oCQgsRasterPyramidThis struct is used to store pyramid info for the raster layer
oCQgsRasterPyramidsOptionsWidgetA widget to select format-specific raster saving options
oCQgsRasterRangeRaster values range container
oCQgsRasterRendererRaster renderer pipe that applies colors to a raster
oCQgsRasterRendererRegistryRegistry for raster renderers
oCQgsRasterRendererRegistryEntryRegistry for raster renderer entries
oCQgsRasterResampleFilterResample filter pipe for rasters
oCQgsRasterResamplerInterface for resampling rasters (e.g
oCQgsRasterShaderInterface for all raster shaders
oCQgsRasterShaderFunctionThe raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color
oCQgsRasterTransparencyDefines the list of pixel values to be considered as transparent or semi transparent when rendering rasters
oCQgsRasterViewPortThis class provides details of the viewable area that a raster will be rendered into
oCQgsRectangleA rectangle specified with double values
oCQgsReliefProduces coloured relief rasters from DEM
oCQgsRenderCheckerThis is a helper class for unit tests that need to write an image and compare it to an expected result or render time
oCQgsRenderContextContains information about the context of a rendering operation
oCQgsRendererV2AbstractMetadataStores metadata about one renderer class
oCQgsRendererV2MetadataConvenience metadata class that uses static functions to create renderer and its widget
oCQgsRendererV2RegistryRegistry of renderers
oCQgsRubberBandA class for drawing transient features (e.g
oCQgsRuggednessFilterCalculates the ruggedness index based on a 3x3 moving window
oCQgsRuleBasedRendererV2When drawing a vector layer with rule-based renderer, it goes through the rules and draws features with symbols from rules that match
oCQgsRunProcessA class that executes an external program/script
oCQgsScaleBarStyleAbstraction of composer scale bar style
oCQgsScaleCalculatorCalculates scale for a given combination of canvas size, map extent, and monitor dpi
oCQgsScaleComboBoxA combobox which lets the user select map scale from predefined list and highlights nearest to current scale value
oCQgsSearchQueryBuilderQuery Builder for search strings
oCQgsSingleBandColorDataRendererRaster renderer pipe for single band color
oCQgsSingleBandGrayRendererRaster renderer pipe for single band gray
oCQgsSingleBandPseudoColorRendererRaster renderer pipe for single band pseudocolor
oCQgsSingleBoxScaleBarStyleScalebar style that draws a single box with alternating color for the segments
oCQgsSingleCategoryDiagramRendererRenders the diagrams for all features with the same settings
oCQgsSlopeFilterCalculates slope values in a window of 3x3 cells based on first order derivatives in x- and y- directions
oCQgsSnapperA class that allows advanced snapping operations on a set of vector layers
oCQgsSnappingResultRepresents the result of a snapping operation
oCQgsSvgCacheA cache for images / pictures derived from svg files
oCQgsSVGFillSymbolLayerA class for svg fill patterns
oCQgsSymbolLayerV2AbstractMetadataStores metadata about one symbol layer class
oCQgsSymbolLayerV2MetadataConvenience metadata class that uses static functions to create symbol layer and its widget
oCQgsSymbolLayerV2RegistryRegistry of available symbol layer classes
oCQgsSymbologyV2ConversionThis class is not a part of public API, it is intended only for compatibility with older versions of QGIS (1.x)
oCQgsTextAnnotationItemAn annotation item that displays formated text
oCQgsTicksScaleBarStyleA scale bar that draws segments using short ticks
oCQgsTINInterpolatorInterpolation in a triangular irregular network
oCQgsToleranceThis is the class is providing tolerance value in map unit values
oCQgsTotalCurvatureFilterCalculates total curvature as described by Wilson, Gallant (2000): terrain analysis
oCQgsVectorA class to represent a vector
oCQgsVectorDataProviderThis is the base class for vector data providers
oCQgsVectorFieldSymbolLayerA symbol layer class for displaying displacement arrows based on point layer attributes
oCQgsVectorFileWriterA convenience class for writing vector files to disk
oCQgsVectorLayerRepresents a vector layer which manages a vector based data sets
oCQgsVectorLayerCacheThis class caches features of a given QgsVectorLayer
oCQgsVectorLayerImportA convenience class for writing vector files to disk
oCQgsVectorLayerJoinBufferManages joined fields for a vector layer
oCQgsVertexMarkerA class for marking vertices of features using e.g
oCQgsZipItemA zip file: contains layers, using GDAL/OGR VSIFILE mechanism
oCQgsZonalStatisticsA class that calculates raster statistics (count, sum, mean) for a polygon or multipolygon layer and appends the results as attributes
oCTriangleInterpolatorThis is an interface for interpolator classes for triangulations
oCTriangulationInterface for Triangulation classes
oCTriDecoratorDecorator class for Triangulations (s
oCVector3DClass Vector3D represents a 3D-Vector, capable to store x-,y- and z-coordinates in double values