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

#include <qgis.h>

Public Types
enum	DataType { UnknownDataType = 0, Byte = 1, UInt16 = 2, Int16 = 3, UInt32 = 4, Int32 = 5, Float32 = 6, Float64 = 7, CInt16 = 8, CInt32 = 9, CFloat32 = 10, CFloat64 = 11, ARGB32 = 12, ARGB32_Premultiplied = 13 }
	Raster data types. More...
enum	GeometryType { Point, Line, Polygon, UnknownGeometry, NoGeometry }
enum	UnitType { Meters = 0, Feet = 1, Degrees = 2, UnknownUnit = 3, DecimalDegrees = 2, DegreesMinutesSeconds = 2, DegreesDecimalMinutes = 2 }
	Map units that qgis supports. More...
enum	UserEvent { ProviderExtentCalcEvent = ( QEvent::User + 1 ), ProviderCountCalcEvent }
	User defined event types. More...
enum	WkbType { WKBUnknown = 0, WKBPoint = 1, WKBLineString, WKBPolygon, WKBMultiPoint, WKBMultiLineString, WKBMultiPolygon, WKBNoGeometry = 100, WKBPoint25D = 0x80000001, WKBLineString25D, WKBPolygon25D, WKBMultiPoint25D, WKBMultiLineString25D, WKBMultiPolygon25D }
	Used for symbology operations. More...
Static Public Member Functions
static const char *	featureType (WkbType type)
	description strings for feature types
static WkbType	flatType (WkbType type)
static UnitType	fromLiteral (QString literal, QGis::UnitType defaultType=UnknownUnit)
	Converts from the canonical name to the type value.
static WkbType	singleType (WkbType type)
static QString	toLiteral (QGis::UnitType unit)
	Provides the canonical name of the type value.
static QString	tr (QGis::UnitType unit)
	Provides translated version of the type value.
static const char *	vectorGeometryType (GeometryType type)
	description strings for geometry types
static int	wkbDimensions (WkbType type)
Static Public Attributes
static const double	DEFAULT_IDENTIFY_RADIUS = 0.5
static const char *	QGIS_DEV_VERSION = QGSVERSION
static const char *	QGIS_RELEASE_NAME = RELEASE_NAME
static const char *	QGIS_VERSION = VERSION
static const int	QGIS_VERSION_INT = VERSION_INT
Static Private Attributes
static const char *	qgisUnitTypes []

Detailed Description

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

Definition at line 33 of file qgis.h.

Member Enumeration Documentation

enum QGis::DataType

Raster data types.

This is modified and extended copy of GDALDataType.

Enumerator:

UnknownDataType	Unknown or unspecified type
Byte	Eight bit unsigned integer (quint8)
UInt16	Sixteen bit unsigned integer (quint16)
Int16	Sixteen bit signed integer (qint16)
UInt32	Thirty two bit unsigned integer (quint32)
Int32	Thirty two bit signed integer (qint32)
Float32	Thirty two bit floating point (float)
Float64	Sixty four bit floating point (double)
CInt16	Complex Int16
CInt32	Complex Int32
CFloat32	Complex Float32
CFloat64	Complex Float64
ARGB32	Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32
ARGB32_Premultiplied	Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32_Premultiplied

Definition at line 162 of file qgis.h.

enum QGis::GeometryType

Enumerator:

Point
Line
Polygon
UnknownGeometry
NoGeometry

Definition at line 114 of file qgis.h.

enum QGis::UnitType

Map units that qgis supports.

Note:: that QGIS < 1.4 api had only Meters, Feet, Degrees and UnknownUnit; and QGIS >1.8 returns to that

Enumerator:

Meters
Feet
Degrees
UnknownUnit
DecimalDegrees
DegreesMinutesSeconds
DegreesDecimalMinutes

Definition at line 187 of file qgis.h.

enum QGis::UserEvent

User defined event types.

Enumerator:

ProviderExtentCalcEvent	The extents have been calculated by a provider of a layer.
ProviderCountCalcEvent	The row count has been calculated by a provider of a layer.

Definition at line 211 of file qgis.h.

enum QGis::WkbType

Used for symbology operations.

Enumerator:

WKBUnknown
WKBPoint
WKBLineString
WKBPolygon
WKBMultiPoint
WKBMultiLineString
WKBMultiPolygon
WKBNoGeometry
WKBPoint25D
WKBLineString25D
WKBPolygon25D
WKBMultiPoint25D
WKBMultiLineString25D
WKBMultiPolygon25D

Definition at line 52 of file qgis.h.

Member Function Documentation

static const char* QGis::featureType ( WkbType type ) [inline, static]

description strings for feature types

Definition at line 138 of file qgis.h.

static WkbType QGis::flatType ( WkbType type ) [inline, static]

Definition at line 84 of file qgis.h.

QGis::UnitType QGis::fromLiteral	(	QString	literal,
		QGis::UnitType	defaultType = `UnknownUnit`
	)		`[static]`

Converts from the canonical name to the type value.

Definition at line 89 of file qgis.cpp.

References qgisUnitTypes.

static WkbType QGis::singleType ( WkbType type ) [inline, static]

Definition at line 70 of file qgis.h.

Referenced by QgsVectorFileWriter::createFeature().

QString QGis::toLiteral ( QGis::UnitType unit ) [static]

Provides the canonical name of the type value.

Definition at line 101 of file qgis.cpp.

References qgisUnitTypes.

Referenced by tr().

QString QGis::tr ( QGis::UnitType unit ) [static]

Provides translated version of the type value.

Definition at line 106 of file qgis.cpp.

References toLiteral().

static const char* QGis::vectorGeometryType ( GeometryType type ) [inline, static]

description strings for geometry types

Definition at line 124 of file qgis.h.

Referenced by QgsVectorLayer::metadata(), and QgsVectorLayer::writeXml().

static int QGis::wkbDimensions ( WkbType type ) [inline, static]

Definition at line 98 of file qgis.h.

Member Data Documentation

const double QGis::DEFAULT_IDENTIFY_RADIUS = 0.5 [static]

Definition at line 222 of file qgis.h.

Referenced by QgsMapTip::fetchFeature(), QgsMapToolIdentify::identifyVectorLayer(), QgsFormAnnotationItem::setFeatureForMapPosition(), and QgsHtmlAnnotationItem::setFeatureForMapPosition().

const char * QGis::QGIS_DEV_VERSION = QGSVERSION [static]

Definition at line 45 of file qgis.h.

Referenced by QgsError::message().

const char * QGis::QGIS_RELEASE_NAME = RELEASE_NAME [static]

Definition at line 43 of file qgis.h.

const char * QGis::QGIS_VERSION = VERSION [static]

Definition at line 39 of file qgis.h.

Referenced by QgsMapLayer::exportNamedStyle(), QgsMapLayer::loadNamedStyle(), QgsProject::read(), and QgsProject::write().

const int QGis::QGIS_VERSION_INT = VERSION_INT [static]

Definition at line 41 of file qgis.h.

const char * QGis::qgisUnitTypes [static, private]

Initial value:

{
  QT_TRANSLATE_NOOP( "QGis::UnitType", "meters" ),
  QT_TRANSLATE_NOOP( "QGis::UnitType", "feet" ),
  QT_TRANSLATE_NOOP( "QGis::UnitType", "degrees" ),
  QT_TRANSLATE_NOOP( "QGis::UnitType", "<unknown>" ),
  QT_TRANSLATE_NOOP( "QGis::UnitType", "degrees" ),
  QT_TRANSLATE_NOOP( "QGis::UnitType", "degrees" ),

}

Definition at line 226 of file qgis.h.

Referenced by fromLiteral(), and toLiteral().

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

src/core/qgis.h
src/core/qgis.cpp

Public Types

Static Public Member Functions

Static Public Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation