QGIS API Documentation
2.4.0-Chugiak
|
Contains all basic GIS functionality. More...
Classes | |
class | QGis |
The QGis class provides global constants for use throughout the application. More... | |
class | QgsApplication |
Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc. More... | |
class | QgsAction |
Utility class that encapsulates an action based on vector attributes. More... | |
class | QgsClipper |
A class to trim lines and polygons to within a rectangular region. More... | |
class | QgsContextHelp |
Provides a context based help browser for a dialog. More... | |
class | QgsCoordinateReferenceSystem |
Class for storing a coordinate reference system (CRS) More... | |
class | QgsCoordinateTransform |
Class for doing transforms between two map coordinate systems. More... | |
class | QgsCredentials |
Interface for requesting credentials in QGIS in GUI independent way. More... | |
class | QgsCsException |
Custom exception class for Coordinate Reference System related exceptions. More... | |
class | QgsDataProvider |
Abstract base class for spatial data provider implementations. More... | |
class | QgsDataSourceURI |
Class for storing the component parts of a PostgreSQL/RDBMS datasource URI. More... | |
class | QgsDistanceArea |
General purpose distance and area calculator. More... | |
class | QgsErrorMessage |
QgsErrorMessage represents single error message. More... | |
class | QgsError |
QgsError is container for error messages (report). More... | |
class | QgsException |
Defines a qgis exception class. More... | |
class | QgsFeature |
The feature class encapsulates a single feature including its id, geometry and a list of field/values attributes. More... | |
class | QgsAbstractFeatureIterator |
Internal feature iterator to be implemented within data providers. More... | |
class | QgsFeatureIterator |
Wrapper for iterator of features from vector data provider or vector layer. More... | |
class | QgsFeatureStore |
Container for features with the same fields and crs. More... | |
class | QgsField |
Encapsulate a field in an attribute table or data source. More... | |
class | QgsFields |
Container of fields for a vector layer. More... | |
struct | QgsFields::Field |
class | QgsHttpTransaction |
HTTP request/response manager that is redirect-aware. More... | |
class | QgsLabel |
A class to render labels. More... | |
struct | QgsLabel::labelpoint |
class | QgsLabelAttributes |
A class to store attributes needed for label rendering. More... | |
class | QgsLogger |
QgsLogger is a class to print debug/warning/error messages to the console. More... | |
class | QgsMapLayer |
Base class for all map layer types. More... | |
class | QgsMapLayerRegistry |
This class tracks map layers that are currently loaded and provides a means to fetch a pointer to a map layer and delete it. More... | |
class | QgsMapRenderer |
A non GUI class for rendering a map layer set onto a QPainter. More... | |
class | QgsMapToPixel |
Perform transforms between map coordinates and device coordinates. More... | |
class | QgsMessageLog |
Interface for logging messages from QGIS in GUI independent way. More... | |
class | QgsMessageOutput |
Interface for showing messages from QGIS in GUI independent way. More... | |
class | QgsLabelComponent |
Maintains current state of more grainular and temporal values when creating/painting component parts of an individual label (e.g. More... | |
class | QgsPluginLayer |
Base class for plugin layers. More... | |
class | QgsPluginLayerType |
class for creating plugin specific layers More... | |
class | QgsPluginLayerRegistry |
a registry of plugin layers types More... | |
class | QgsVector |
A class to represent a vector. More... | |
class | QgsPoint |
A class to represent a point geometry. More... | |
class | QgsProject |
Reads and writes project states. More... | |
class | QgsProperty |
An Abstract Base Class for QGIS project property hierarchies. More... | |
class | QgsProjectVersion |
A class to describe the version of a project. More... | |
class | QgsProviderCountCalcEvent |
A custom event that is designed to be fired when a layer count has been fully calculated. More... | |
class | QgsProviderExtentCalcEvent |
A custom event that is designed to be fired when a layer extent has been fully calculated. More... | |
class | QgsProviderMetadata |
Holds data provider key, description, and associated shared library file information. More... | |
class | QgsProviderRegistry |
A registry / canonical manager of data providers. More... | |
class | QgsRectangle |
A rectangle specified with double values. More... | |
class | QgsRenderContext |
Contains information about the context of a rendering operation. More... | |
class | QgsRunProcess |
A class that executes an external program/script. More... | |
class | QgsScaleCalculator |
Calculates scale for a given combination of canvas size, map extent, and monitor dpi. More... | |
struct | QgsSnappingResult |
Represents the result of a snapping operation. More... | |
class | QgsTolerance |
This is the class is providing tolerance value in map unit values. More... | |
class | QgsVectorDataProvider |
This is the base class for vector data providers. More... | |
struct | QgsVectorDataProvider::NativeType |
class | QgsVectorFileWriter |
A convenience class for writing vector files to disk. More... | |
struct | QgsVectorFileWriter::MetaData |
class | QgsVectorFileWriter::HiddenOption |
class | QgsVectorFileWriter::BoolOption |
class | QgsVectorFileWriter::IntOption |
class | QgsVectorFileWriter::StringOption |
class | QgsVectorFileWriter::SetOption |
class | QgsVectorFileWriter::Option |
class | QgsVectorLayer |
Represents a vector layer which manages a vector based data sets. More... | |
struct | QgsVectorLayer::TabData |
struct | QgsVectorLayer::GroupData |
struct | QgsVectorLayer::ValueRelationData |
struct | QgsVectorLayer::RangeData |
class | QgsVectorLayerImport |
A convenience class for writing vector files to disk. More... | |
class | QgsBilinearRasterResampler |
Bilinear Raster Resampler. More... | |
class | QgsBrightnessContrastFilter |
Brightness/contrast filter pipe for rasters. More... | |
class | QgsClipToMinMaxEnhancement |
A raster contrast enhancement that will clip a value to the specified min/max range. More... | |
class | QgsColorRampShader |
A ramp shader will color a raster pixel based on a list of values ranges in a ramp. More... | |
struct | QgsColorRampShader::ColorRampItem |
class | QgsContrastEnhancement |
Manipulates raster pixel values so that they enhanceContrast or clip into a specified numerical range according to the specified ContrastEnhancementAlgorithm. More... | |
class | QgsContrastEnhancementFunction |
A contrast enhancement funcion is the base class for all raster contrast enhancements. More... | |
class | QgsCubicRasterResampler |
Cubic Raster Resampler. More... | |
class | QgsHueSaturationFilter |
Color and saturation filter pipe for rasters. More... | |
class | QgsLinearMinMaxEnhancement |
A color enhancement function that performs a linear enhanceContrast between min and max. More... | |
class | QgsLinearMinMaxEnhancementWithClip |
A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max. More... | |
class | QgsMultiBandColorRenderer |
Renderer for multiband images with the color components. More... | |
class | QgsPalettedRasterRenderer |
Renderer for paletted raster images. More... | |
class | QgsPseudoColorShader |
A raster color shader that highlighs low values in blue and high values in red. More... | |
class | QgsRaster |
Raster namespace. More... | |
class | QgsRasterBandStats |
The RasterBandStats struct is a container for statistics about a single raster band. More... | |
class | QgsRasterBlock |
Raster data container. More... | |
class | QgsRasterDataProvider |
Base class for raster data providers. More... | |
class | QgsRasterDrawer |
The drawing pipe for raster layers. More... | |
class | QgsRasterFileWriter |
The raster file writer which allows you to save a raster to a new file. More... | |
class | QgsRasterHistogram |
The QgsRasterHistogram is a container for histogram of a single raster band. More... | |
class | QgsRasterIdentifyResult |
Raster identify results container. More... | |
class | QgsRasterInterface |
Base class for processing filters like renderers, reprojector, resampler etc. More... | |
class | QgsRasterIterator |
Iterator for sequentially processing raster cells. More... | |
struct | QgsRasterIterator::RasterPartInfo |
class | QgsRasterLayer |
This class provides qgis with the ability to render raster datasets onto the mapcanvas. More... | |
class | QgsRasterNuller |
Raster pipe that deals with null values. More... | |
struct | QgsRasterNuller::NoData |
class | QgsRasterPipe |
Base class for processing modules. More... | |
class | QgsRasterPyramid |
This struct is used to store pyramid info for the raster layer. More... | |
class | QgsRasterRange |
Raster values range container. More... | |
class | QgsRasterRenderer |
Raster renderer pipe that applies colors to a raster. More... | |
struct | QgsRasterRendererRegistryEntry |
Registry for raster renderer entries. More... | |
class | QgsRasterRendererRegistry |
Registry for raster renderers. More... | |
class | QgsRasterResampleFilter |
Resample filter pipe for rasters. More... | |
class | QgsRasterResampler |
Interface for resampling rasters (e.g. More... | |
class | QgsRasterShader |
Interface for all raster shaders. More... | |
class | QgsRasterShaderFunction |
The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color. More... | |
class | QgsRasterTransparency |
Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters. More... | |
struct | QgsRasterTransparency::TransparentSingleValuePixel |
struct | QgsRasterTransparency::TransparentThreeValuePixel |
struct | QgsRasterViewPort |
This class provides details of the viewable area that a raster will be rendered into. More... | |
class | QgsSingleBandColorDataRenderer |
Raster renderer pipe for single band color. More... | |
class | QgsSingleBandGrayRenderer |
Raster renderer pipe for single band gray. More... | |
class | QgsSingleBandPseudoColorRenderer |
Raster renderer pipe for single band pseudocolor. More... | |
class | QgsDataDefined |
A container class for data source field mapping or expression. More... | |
Contains all basic GIS functionality.
Enumerator | |
---|---|
Generic | |
GenericPython | |
Mac | |
Windows | |
Unix | |
OpenUrl |
Definition at line 43 of file qgsattributeaction.h.
Blending modes enum defining the available composition modes that can be used when rendering a layer.
Enumerator | |
---|---|
BlendNormal | |
BlendLighten | |
BlendScreen | |
BlendDodge | |
BlendAddition | |
BlendDarken | |
BlendMultiply | |
BlendBurn | |
BlendOverlay | |
BlendSoftLight | |
BlendHardLight | |
BlendDifference | |
BlendSubtract |
Definition at line 150 of file qgsmaprenderer.h.
enum QgsClipper::Boundary |
Enumerator | |
---|---|
XMax | |
XMin | |
YMax | |
YMin |
Definition at line 69 of file qgsclipper.h.
If you add to this, please also add to capabilitiesString()
Enumerator | |
---|---|
NoCapabilities | |
Size | |
Create | |
Remove | |
BuildPyramids | |
Identify | |
IdentifyValue | |
IdentifyText | |
IdentifyHtml | |
IdentifyFeature |
Definition at line 41 of file qgsrasterinterface.h.
enumeration with capabilities that providers might implement
Definition at line 58 of file qgsvectordataprovider.h.
Definition at line 32 of file qgsraster.h.
Enumerator | |
---|---|
INTERPOLATED | |
DISCRETE | |
EXACT |
Definition at line 57 of file qgscolorrampshader.h.
This enumerator describes the types of shading that can be used.
Enumerator | |
---|---|
UndefinedShader | |
PseudoColorShader | |
FreakOutShader | |
ColorRampShader | |
UserDefinedShader |
Definition at line 215 of file qgsrasterlayer.h.
This enumerator describes the types of contrast enhancement algorithms that can be used.
Enumerator | |
---|---|
NoEnhancement | |
StretchToMinimumMaximum | |
StretchAndClipToMinimumMaximum | |
ClipToMinimumMaximum | |
UserDefinedEnhancement |
Definition at line 44 of file qgscontrastenhancement.h.
Contrast enhancement limits.
Enumerator | |
---|---|
ContrastEnhancementNone | |
ContrastEnhancementMinMax | |
ContrastEnhancementStdDev | |
ContrastEnhancementCumulativeCut |
Definition at line 86 of file qgsraster.h.
Enumerator | |
---|---|
InternalCrsId | |
PostgisCrsId | |
EpsgCrsId |
Definition at line 54 of file qgscoordinatereferencesystem.h.
Enumerator | |
---|---|
NoDataCapabilities | |
File | |
Dir | |
Database | |
Net |
Definition at line 52 of file qgsdataprovider.h.
enum QGis::DataType |
Raster data types.
This is modified and extended copy of GDALDataType.
This enumerator describes the different kinds of drawing we can do.
Definition at line 95 of file qgsraster.h.
The different types to layout the attribute editor.
Enumerator | |
---|---|
GeneratedLayout | |
TabLayout | |
UiFileLayout |
Definition at line 461 of file qgsvectorlayer.h.
Definition at line 471 of file qgsvectorlayer.h.
Types of feature form suppression after feature creation.
Enumerator | |
---|---|
SuppressDefault | |
SuppressOn | |
SuppressOff |
Definition at line 498 of file qgsvectorlayer.h.
Definition at line 165 of file qgsfield.h.
enum QGis::GeometryType |
Enumerator | |
---|---|
BlackToWhite | |
WhiteToBlack |
Definition at line 32 of file qgssinglebandgrayrenderer.h.
Enumerator | |
---|---|
GrayscaleOff | |
GrayscaleLightness | |
GrayscaleLuminosity | |
GrayscaleAverage |
Definition at line 34 of file qgshuesaturationfilter.h.
Enumerator | |
---|---|
IdentifyFormatUndefined | |
IdentifyFormatValue | |
IdentifyFormatText | |
IdentifyFormatHtml | |
IdentifyFormatFeature |
Definition at line 54 of file qgsraster.h.
Definition at line 40 of file qgsvectorlayerimport.h.
enum QgsLabel::LabelField |
Definition at line 59 of file qgslabel.h.
Layers enum defining the types of layers that can be added to a map.
Enumerator | |
---|---|
VectorLayer | |
RasterLayer | |
PluginLayer |
Definition at line 53 of file qgsmaplayer.h.
This enumerator describes the type of raster layer.
Enumerator | |
---|---|
GrayOrUndefined | |
Palette | |
Multiband | |
ColorLayer |
Definition at line 225 of file qgsrasterlayer.h.
Enumerator | |
---|---|
INFO | |
WARNING | |
CRITICAL |
Definition at line 40 of file qgsmessagelog.h.
message can be in plain text or in html format
Enumerator | |
---|---|
MessageText | |
MessageHtml |
Definition at line 43 of file qgsmessageoutput.h.
Enumerator | |
---|---|
MinMaxUnknown | |
MinMaxUser | |
MinMaxMinMax | |
MinMaxCumulativeCut | |
MinMaxStdDev | |
MinMaxFullExtent | |
MinMaxSubExtent | |
MinMaxEstimated | |
MinMaxExact |
Definition at line 38 of file qgsrasterrenderer.h.
Enumerator | |
---|---|
Raw | |
Image |
Definition at line 35 of file qgsrasterfilewriter.h.
Enumerator | |
---|---|
Set | |
String | |
Int | |
Hidden |
Definition at line 45 of file qgsvectorfilewriter.h.
Output units for pen width and point marker width/height.
Enumerator | |
---|---|
Millimeters | |
Pixels |
Definition at line 140 of file qgsmaprenderer.h.
Enumerator | |
---|---|
PyramidsFlagNo | |
PyramidsFlagYes | |
PyramidsCopyExisting |
Definition at line 71 of file qgsraster.h.
Enumerator | |
---|---|
ProgressHistogram | |
ProgressPyramids | |
ProgressStatistics |
Definition at line 64 of file qgsraster.h.
Enumerator | |
---|---|
PyramidsGTiff | |
PyramidsInternal | |
PyramidsErdas |
Definition at line 78 of file qgsraster.h.
enum QgsRasterPipe::Role |
Enumerator | |
---|---|
UnknownRole | |
ProviderRole | |
RendererRole | |
BrightnessRole | |
ResamplerRole | |
ProjectorRole | |
NullerRole | |
HueSaturationRole |
Definition at line 45 of file qgsrasterpipe.h.
Enumerator | |
---|---|
SSLprefer | |
SSLdisable | |
SSLallow | |
SSLrequire |
Definition at line 39 of file qgsdatasourceuri.h.
Enumerator | |
---|---|
None | |
Min | |
Max | |
Range | |
Sum | |
Mean | |
StdDev | |
SumOfSquares | |
All |
Definition at line 36 of file qgsrasterbandstats.h.
Enumerator | |
---|---|
NoSymbology | |
FeatureSymbology | |
SymbolLayerSymbology |
Definition at line 157 of file qgsvectorfilewriter.h.
Enum used to indicate the direction (forward or inverse) of the transform.
Enumerator | |
---|---|
ForwardTransform |
Transform from source to destination CRS. |
ReverseTransform |
Transform from destination to source CRS. |
Definition at line 94 of file qgscoordinatetransform.h.
Enumerator | |
---|---|
MapUnits | |
PointUnits |
Definition at line 87 of file qgslabelattributes.h.
Type of unit of tolerance value from settings.
Enumerator | |
---|---|
MapUnits |
Map unit value. |
Pixels |
Pixels unit of tolerance. |
Definition at line 33 of file qgstolerance.h.
enum QGis::UnitType |
enum QGis::UserEvent |
Editing vertex markers.
Enumerator | |
---|---|
SemiTransparentCircle | |
Cross | |
NoMarker |
Definition at line 1381 of file qgsvectorlayer.h.
enum QGis::WkbType |
Enumerator | |
---|---|
NoError | |
SourceProviderError | |
DestProviderError | |
CreateDatasourceError | |
WriteError | |
NoDataConflict |
Definition at line 40 of file qgsrasterfilewriter.h.
Enumerator | |
---|---|
NoError | |
ErrDriverNotFound | |
ErrCreateDataSource | |
ErrCreateLayer | |
ErrAttributeTypeUnsupported | |
ErrAttributeCreationFailed | |
ErrProjection | |
ErrFeatureWriteFailed | |
ErrInvalidLayer |
Definition at line 143 of file qgsvectorfilewriter.h.