QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
QGis Class Reference

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 More...
 
static WkbType flatType (WkbType type)
 
static UnitType fromLiteral (QString literal, QGis::UnitType defaultType=UnknownUnit)
 Converts from the canonical name to the type value. More...
 
static double fromUnitToUnitFactor (QGis::UnitType fromUnit, QGis::UnitType toUnit)
 Returns the conversion factor between the specified units. More...
 
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. More...
 
static QString tr (QGis::UnitType unit)
 Provides translated version of the type value. More...
 
static const char * vectorGeometryType (GeometryType type)
 description strings for geometry types More...
 
static int wkbDimensions (WkbType type)
 

Static Public Attributes

static double DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5
 Default highlight buffer in mm. More...
 
static const QColor DEFAULT_HIGHLIGHT_COLOR = QColor( 255, 0, 0, 128 )
 Default highlight color. More...
 
static double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0
 Default highlight line/outline minimum width in mm. More...
 
static const double DEFAULT_IDENTIFY_RADIUS = 0.5
 Old search radius in % of canvas width. More...
 
static const float DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0f
 Default threshold between map coordinates and device coordinates for map2pixel simplification. More...
 
static const double DEFAULT_SEARCH_RADIUS_MM = 2.
 Identify search radius in mm. More...
 
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 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.

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

Returns the conversion factor between the specified units.

Definition at line 123 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 282 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 278 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 286 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 266 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 273 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 270 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: