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, NauticalMiles = 7 }
	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 UnitType	fromTr (QString literal, QGis::UnitType defaultType=UnknownUnit)
	Provides type value from translated version.
static double	fromUnitToUnitFactor (QGis::UnitType fromUnit, QGis::UnitType toUnit)
	Returns the conversion factor between the specified units.
static bool	isMultiType (WkbType type)
static bool	isSingleType (WkbType type)
static WkbType	multiType (WkbType type)
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 double	DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5
	Default highlight buffer in mm.
static const QColor	DEFAULT_HIGHLIGHT_COLOR = QColor( 255, 0, 0, 128 )
	Default highlight color.
static double	DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0
	Default highlight line/outline minimum width in mm.
static const double	DEFAULT_IDENTIFY_RADIUS = 0.5
	Old search radius in % of canvas width.
static const float	DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0f
	Default threshold between map coordinates and device coordinates for map2pixel simplification.
static const double	DEFAULT_SEARCH_RADIUS_MM = 2.
	Identify search radius in mm.
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

Detailed Description

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

Definition at line 34 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 204 of file qgis.h.

enum QGis::GeometryType

Enumerator:

Point
Line
Polygon
UnknownGeometry
NoGeometry

Definition at line 155 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
NauticalMiles

Definition at line 229 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 255 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 53 of file qgis.h.

Member Function Documentation

static const char* QGis::featureType ( WkbType type )

inlinestatic

description strings for feature types

Definition at line 179 of file qgis.h.

static WkbType QGis::flatType ( WkbType type )

inlinestatic

Definition at line 99 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 101 of file qgis.cpp.

QGis::UnitType QGis::fromTr	(	QString	literal,
		QGis::UnitType	defaultType = `UnknownUnit`
	)

static

Provides type value from translated version.

Definition at line 123 of file qgis.cpp.

double QGis::fromUnitToUnitFactor	(	QGis::UnitType	fromUnit,
		QGis::UnitType	toUnit
	)

static

Returns the conversion factor between the specified units.

Definition at line 135 of file qgis.cpp.

static bool QGis::isMultiType ( WkbType type )

inlinestatic

Definition at line 126 of file qgis.h.

static bool QGis::isSingleType ( WkbType type )

inlinestatic

Definition at line 113 of file qgis.h.

static WkbType QGis::multiType ( WkbType type )

inlinestatic

Definition at line 85 of file qgis.h.

static WkbType QGis::singleType ( WkbType type )

inlinestatic

Definition at line 71 of file qgis.h.

QString QGis::toLiteral ( QGis::UnitType unit )

static

Provides the canonical name of the type value.

Definition at line 113 of file qgis.cpp.

QString QGis::tr ( QGis::UnitType unit )

static

Provides translated version of the type value.

Definition at line 118 of file qgis.cpp.

static const char* QGis::vectorGeometryType ( GeometryType type )

inlinestatic

description strings for geometry types

Definition at line 165 of file qgis.h.

static int QGis::wkbDimensions ( WkbType type )

inlinestatic

Definition at line 139 of file qgis.h.

Member Data Documentation

double QGis::DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5

static

Default highlight buffer in mm.

Note: added in 2.3

Definition at line 284 of file qgis.h.

const QColor QGis::DEFAULT_HIGHLIGHT_COLOR = QColor( 255, 0, 0, 128 )

static

Default highlight color.

The transparency is expected to only be applied to polygon fill. Lines and outlines are rendered opaque.

Note: added in 2.3

Definition at line 280 of file qgis.h.

double QGis::DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0

static

Default highlight line/outline minimum width in mm.

Note: added in 2.3

Definition at line 288 of file qgis.h.

const double QGis::DEFAULT_IDENTIFY_RADIUS = 0.5

static

Old search radius in % of canvas width.

Deprecated:: since 2.3, use DEFAULT_SEARCH_RADIUS_MM

Definition at line 268 of file qgis.h.

const float QGis::DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0f

static

Default threshold between map coordinates and device coordinates for map2pixel simplification.

Definition at line 275 of file qgis.h.

const double QGis::DEFAULT_SEARCH_RADIUS_MM = 2.

static

Identify search radius in mm.

Note: added in 2.3

Definition at line 272 of file qgis.h.

const char * QGis::QGIS_DEV_VERSION = QGSVERSION

static

Definition at line 46 of file qgis.h.

const char * QGis::QGIS_RELEASE_NAME = RELEASE_NAME

static

Definition at line 44 of file qgis.h.

const char * QGis::QGIS_VERSION = VERSION

static

Definition at line 40 of file qgis.h.

const int QGis::QGIS_VERSION_INT = VERSION_INT

static

Definition at line 42 of file qgis.h.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgis.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgis.cpp

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation