QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Macros | Typedefs | Functions | Variables
qgis.h File Reference
#include <QEvent>
#include <QString>
#include <QRegExp>
#include <QMetaType>
#include <QVariant>
#include <stdlib.h>
#include <cfloat>
#include <cmath>
#include <qnumeric.h>
Include dependency graph for qgis.h:

Go to the source code of this file.

Classes

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

Macros

#define Q_NOWARN_DEPRECATED_PUSH
 
#define Q_NOWARN_DEPRECATED_POP
 
#define QGISEXTERN   extern "C"
 

Typedefs

typedef QMap< QString, QString > QgsStringMap
 
typedef unsigned long long qgssize
 qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be hard to define size_t correctly in SIP. More...
 

Functions

QString qgsDoubleToString (const double &a, const int &precision=17)
 
bool qgsDoubleNear (double a, double b, double epsilon=4 *DBL_EPSILON)
 
bool qgsDoubleNearSig (double a, double b, int significantDigits=10)
 
bool qgsVariantLessThan (const QVariant &lhs, const QVariant &rhs)
 
bool qgsVariantGreaterThan (const QVariant &lhs, const QVariant &rhs)
 
QString qgsVsiPrefix (QString path)
 
void CORE_EXPORT * qgsMalloc (size_t size)
 Allocates size bytes and returns a pointer to the allocated memory. More...
 
void CORE_EXPORT * qgsCalloc (size_t nmemb, size_t size)
 Allocates memory for an array of nmemb elements of size bytes each and returns a pointer to the allocated memory. More...
 
void CORE_EXPORT qgsFree (void *ptr)
 Frees the memory space pointed to by ptr. More...
 

Variables

void(*)() cast_to_fptr (void *p)
 
CORE_EXPORT const QString GEOWKT
 Wkt string that represents a geographic coord sys. More...
 
CORE_EXPORT const QString PROJECT_SCALES
 
CORE_EXPORT const QString GEOPROJ4
 PROJ4 string that represents a geographic coord sys. More...
 
const long GEOSRID = 4326
 Magic number for a geographic coord sys in POSTGIS SRID. More...
 
const long GEOCRS_ID = 3452
 Magic number for a geographic coord sys in QGIS srs.db tbl_srs.srs_id. More...
 
const long GEO_EPSG_CRS_ID = 4326
 Magic number for a geographic coord sys in EpsgCrsId ID format. More...
 
CORE_EXPORT const QString GEO_EPSG_CRS_AUTHID
 Geographic coord sys from EPSG authority. More...
 
const int PROJ_PREFIX_LEN = 6
 The length of the string "+proj=". More...
 
const int ELLPS_PREFIX_LEN = 7
 The length of the string "+ellps=". More...
 
const int LAT_PREFIX_LEN = 7
 The length of the string "+lat_1=". More...
 
const int USER_CRS_START_ID = 100000
 Magick number that determines whether a projection crsid is a system (srs.db) or user (~/.qgis.qgis.db) defined projection. More...
 
CORE_EXPORT const QString GEO_NONE
 Constant that holds the string representation for "No ellips/No CRS". More...
 
const double MINIMUM_POINT_SIZE = 0.1
 Magic number that determines the minimum allowable point size for point symbols. More...
 
const double DEFAULT_POINT_SIZE = 2.0
 Magic number that determines the default point size for point symbols. More...
 
const double DEFAULT_LINE_WIDTH = 0.26
 
const double DEFAULT_SEGMENT_EPSILON = 1e-8
 default snapping tolerance for segments ( More...
 

Macro Definition Documentation

#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_PUSH
#define QGISEXTERN   extern "C"

Typedef Documentation

typedef unsigned long long qgssize

qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be hard to define size_t correctly in SIP.

Currently used "unsigned long long" was introduced in C++11 (2011) but it was supported already before C++11 on common platforms. "unsigned long long int" gives syntax error in SIP. KEEP IN SYNC WITH qgssize defined in SIP!

typedef QMap<QString, QString> QgsStringMap

Function Documentation

void CORE_EXPORT* qgsCalloc ( size_t  nmemb,
size_t  size 
)

Allocates memory for an array of nmemb elements of size bytes each and returns a pointer to the allocated memory.

Works like C calloc() but prints debug message by QgsLogger if allocation fails.

Parameters
nmembnumber of elements
sizesize of element in bytes
bool qgsDoubleNear ( double  a,
double  b,
double  epsilon = 4 * DBL_EPSILON 
)
inline
bool qgsDoubleNearSig ( double  a,
double  b,
int  significantDigits = 10 
)
inline
QString qgsDoubleToString ( const double &  a,
const int &  precision = 17 
)
inline
void CORE_EXPORT qgsFree ( void *  ptr)

Frees the memory space pointed to by ptr.

Works like C free().

Parameters
ptrpointer to memory space
void CORE_EXPORT* qgsMalloc ( size_t  size)

Allocates size bytes and returns a pointer to the allocated memory.

Works like C malloc() but prints debug message by QgsLogger if allocation fails.

Parameters
sizesize in bytes
bool qgsVariantGreaterThan ( const QVariant &  lhs,
const QVariant &  rhs 
)
bool qgsVariantLessThan ( const QVariant &  lhs,
const QVariant &  rhs 
)
QString qgsVsiPrefix ( QString  path)

Variable Documentation

void( *)() cast_to_fptr(void *p)
inline
const double DEFAULT_LINE_WIDTH = 0.26
const double DEFAULT_POINT_SIZE = 2.0

Magic number that determines the default point size for point symbols.

const double DEFAULT_SEGMENT_EPSILON = 1e-8

default snapping tolerance for segments (

Note
added in 1.8)
const int ELLPS_PREFIX_LEN = 7

The length of the string "+ellps=".

CORE_EXPORT const QString GEO_EPSG_CRS_AUTHID

Geographic coord sys from EPSG authority.

const long GEO_EPSG_CRS_ID = 4326

Magic number for a geographic coord sys in EpsgCrsId ID format.

CORE_EXPORT const QString GEO_NONE

Constant that holds the string representation for "No ellips/No CRS".

const long GEOCRS_ID = 3452

Magic number for a geographic coord sys in QGIS srs.db tbl_srs.srs_id.

CORE_EXPORT const QString GEOPROJ4

PROJ4 string that represents a geographic coord sys.

const long GEOSRID = 4326

Magic number for a geographic coord sys in POSTGIS SRID.

CORE_EXPORT const QString GEOWKT

Wkt string that represents a geographic coord sys.

Note
added in 1.8 to replace GEOWkt
const int LAT_PREFIX_LEN = 7

The length of the string "+lat_1=".

const double MINIMUM_POINT_SIZE = 0.1

Magic number that determines the minimum allowable point size for point symbols.

const int PROJ_PREFIX_LEN = 6

The length of the string "+proj=".

CORE_EXPORT const QString PROJECT_SCALES
const int USER_CRS_START_ID = 100000

Magick number that determines whether a projection crsid is a system (srs.db) or user (~/.qgis.qgis.db) defined projection.