QgsApplication Class Reference
[QGIS core library]

Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc. More...

#include <qgsapplication.h>

List of all members.

Public Types

enum ENDIAN { XDR = 0, NDR = 1 }

constants for endian-ness More...

typedef enum QgsApplication::ENDIAN endian_t

constants for endian-ness

Public Member Functions

QgsApplication (int &argc, char **argv, bool GUIenabled, QString customConfigPath=QString())

virtual ~QgsApplication ()

virtual bool notify (QObject *receiver, QEvent *event)

Catch exceptions when sending event to receiver.

Static Public Member Functions

static void setThemeName (const QString theThemeName)

Set the active theme to the specified theme.

static const QString themeName ()

Set the active theme to the specified theme.

static const QString authorsFilePath ()

Returns the path to the authors file.

static const QString contributorsFilePath ()

Returns the path to the contributors file.

static const QString sponsorsFilePath ()

Returns the path to the sponsors file.

static const QString donorsFilePath ()

Returns the path to the donors file.

static const QString translatorsFilePath ()

Returns the path to the sponsors file.

static const QString developerPath ()

Returns the path to the developer image directory.

static const QString helpAppPath ()

Returns the path to the help application.

static const QString msexportAppPath ()

Returns the path to the mapserver export application.

static const QString i18nPath ()

Returns the path to the translation directory.

static const QString qgisMasterDbFilePath ()

Returns the path to the master qgis.db file.

static const QString qgisSpatialiteDbTemplatePath ()

Returns the path to the spatialite template db file.

static const QString qgisSettingsDirPath ()

Returns the path to the settings directory in user's home dir.

static const QString qgisUserDbFilePath ()

Returns the path to the user qgis.db file.

static const QString splashPath ()

Returns the path to the splash screen image directory.

static const QString iconsPath ()

Returns the path to the icons image directory.

static const QString srsDbFilePath ()

Returns the path to the srs.db file.

static const QStringList svgPaths ()

Returns the pathes to svg directories.

static const QString svgPath ()

Returns the paths to svg applications svg directory.

static const QString prefixPath ()

Returns the path to the application prefix directory.

static const QString pluginPath ()

Returns the path to the application plugin directory.

static const QString pkgDataPath ()

Returns the common root path of all application data directories.

static const QString activeThemePath ()

Returns the path to the currently active theme directory.

static const QString defaultThemePath ()

Returns the path to the default theme directory.

static QString iconPath (QString iconFile)

Returns path to the desired icon file.

static const QString userStyleV2Path ()

Returns the path to user's style. Added in QGIS 1.4.

static const QString defaultStyleV2Path ()

Returns the path to default style (works as a starting point). Added in QGIS 1.4.

static void setPrefixPath (const QString thePrefixPath, bool useDefaultPaths=false)

Alters prefix path - used by 3rd party apps.

static void setPluginPath (const QString thePluginPath)

Alters plugin path - used by 3rd party apps.

static void setPkgDataPath (const QString thePkgDataPath)

Alters pkg data path - used by 3rd party apps.

static void setDefaultSvgPaths (const QStringList &pathList)

Alters default svg paths - used by 3rd party apps. Added in QGIS 1.5.

static void initQgis ()

loads providers

static void exitQgis ()

deletes provider registry and map layer registry

static endian_t endian ()

Returns whether this machine uses big or little endian.

static QString reportStyleSheet ()

get a standard css style sheet for reports.

static QString showSettings ()

Convenience function to get a summary of the paths used in this application instance useful for debugging mainly.

static void registerOgrDrivers ()

Register OGR drivers ensuring this only happens once.

static QString absolutePathToRelativePath (QString apath, QString targetPath)

Converts absolute path to path relative to target.

static QString relativePathToAbsolutePath (QString rpath, QString targetPath)

Converts path relative to target to an absolute path.

Static Private Attributes

static QString mPrefixPath

static QString mPluginPath

static QString mPkgDataPath

static QString mThemeName

static QStringList mDefaultSvgPaths

static QString mConfigPath = QDir::homePath() + QString( "/.qgis/" )

Detailed Description

Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc.

The QgsApplication class manages application-wide information.

This is a subclass of QApplication and should be instantiated in place of QApplication. Most methods are static in keeping witn the design of QApplication.

This class hides platform-specific path information and provides a portable way of referencing specific files and directories. Ideally, hard-coded paths should appear only here and not in other modules so that platform-conditional code is minimized and paths are easier to change due to centralization.

Definition at line 25 of file qgsapplication.h.

Member Typedef Documentation

typedef enum QgsApplication::ENDIAN QgsApplication::endian_t

constants for endian-ness

Member Enumeration Documentation

enum QgsApplication::ENDIAN

constants for endian-ness

Enumerator:

XDR
NDR

Definition at line 165 of file qgsapplication.h.

Constructor & Destructor Documentation

QgsApplication::QgsApplication	(	int &	argc,
		char **	argv,
		bool	GUIenabled,
		QString	customConfigPath = `QString()`
	)

Note:: customConfigDir parameter added in v1.6

Definition at line 57 of file qgsapplication.cpp.

References mConfigPath, mDefaultSvgPaths, mPkgDataPath, qgisSettingsDirPath(), and setPrefixPath().

QgsApplication::~QgsApplication ( ) [virtual]

Definition at line 78 of file qgsapplication.cpp.

Member Function Documentation

bool QgsApplication::notify	(	QObject *	receiver,
		QEvent *	event
	)			`[virtual]`

Catch exceptions when sending event to receiver.

Definition at line 82 of file qgsapplication.cpp.

References QgsException::what().

void QgsApplication::setThemeName ( const QString theThemeName ) [static]

Set the active theme to the specified theme.

The theme name should be a single word e.g. 'default','classic'. The theme search path usually will be pkgDataPath + "/themes/" + themName + "/" but plugin writers etc can use themeName() as a basis for searching for resources in their own datastores e.g. a Qt4 resource bundle.

Note:: A basic test will be carried out to ensure the theme search path based on the supplied theme name exists. If it does not the theme name will be reverted to 'default'.

Set the theme path to the specified theme.

Definition at line 173 of file qgsapplication.cpp.

References mThemeName.

const QString QgsApplication::themeName ( ) [static]

Set the active theme to the specified theme.

The theme name should be a single word e.g. 'default','classic'. The theme search path usually will be pkgDataPath + "/themes/" + themName + "/" but plugin writers etc can use this method as a basis for searching for resources in their own datastores e.g. a Qt4 resource bundle.

Get the active theme name

Definition at line 189 of file qgsapplication.cpp.

References mThemeName.

Referenced by showSettings().

const QString QgsApplication::authorsFilePath ( ) [static]

Returns the path to the authors file.

Definition at line 196 of file qgsapplication.cpp.


Public Types
enum	ENDIAN { XDR = 0, NDR = 1 }
	constants for endian-ness More...
typedef enum QgsApplication::ENDIAN	endian_t
	constants for endian-ness
Public Member Functions
	QgsApplication (int &argc, char **argv, bool GUIenabled, QString customConfigPath=QString())
virtual	~QgsApplication ()
virtual bool	notify (QObject receiver, QEvent event)
	Catch exceptions when sending event to receiver.
Static Public Member Functions
static void	setThemeName (const QString theThemeName)
	Set the active theme to the specified theme.
static const QString	themeName ()
	Set the active theme to the specified theme.
static const QString	authorsFilePath ()
	Returns the path to the authors file.
static const QString	contributorsFilePath ()
	Returns the path to the contributors file.
static const QString	sponsorsFilePath ()
	Returns the path to the sponsors file.
static const QString	donorsFilePath ()
	Returns the path to the donors file.
static const QString	translatorsFilePath ()
	Returns the path to the sponsors file.
static const QString	developerPath ()
	Returns the path to the developer image directory.
static const QString	helpAppPath ()
	Returns the path to the help application.
static const QString	msexportAppPath ()
	Returns the path to the mapserver export application.
static const QString	i18nPath ()
	Returns the path to the translation directory.
static const QString	qgisMasterDbFilePath ()
	Returns the path to the master qgis.db file.
static const QString	qgisSpatialiteDbTemplatePath ()
	Returns the path to the spatialite template db file.
static const QString	qgisSettingsDirPath ()
	Returns the path to the settings directory in user's home dir.
static const QString	qgisUserDbFilePath ()
	Returns the path to the user qgis.db file.
static const QString	splashPath ()
	Returns the path to the splash screen image directory.
static const QString	iconsPath ()
	Returns the path to the icons image directory.
static const QString	srsDbFilePath ()
	Returns the path to the srs.db file.
static const QStringList	svgPaths ()
	Returns the pathes to svg directories.
static const QString	svgPath ()
	Returns the paths to svg applications svg directory.
static const QString	prefixPath ()
	Returns the path to the application prefix directory.
static const QString	pluginPath ()
	Returns the path to the application plugin directory.
static const QString	pkgDataPath ()
	Returns the common root path of all application data directories.
static const QString	activeThemePath ()
	Returns the path to the currently active theme directory.
static const QString	defaultThemePath ()
	Returns the path to the default theme directory.
static QString	iconPath (QString iconFile)
	Returns path to the desired icon file.
static const QString	userStyleV2Path ()
	Returns the path to user's style. Added in QGIS 1.4.
static const QString	defaultStyleV2Path ()
	Returns the path to default style (works as a starting point). Added in QGIS 1.4.
static void	setPrefixPath (const QString thePrefixPath, bool useDefaultPaths=false)
	Alters prefix path - used by 3rd party apps.
static void	setPluginPath (const QString thePluginPath)
	Alters plugin path - used by 3rd party apps.
static void	setPkgDataPath (const QString thePkgDataPath)
	Alters pkg data path - used by 3rd party apps.
static void	setDefaultSvgPaths (const QStringList &pathList)
	Alters default svg paths - used by 3rd party apps. Added in QGIS 1.5.
static void	initQgis ()
	loads providers
static void	exitQgis ()
	deletes provider registry and map layer registry
static endian_t	endian ()
	Returns whether this machine uses big or little endian.
static QString	reportStyleSheet ()
	get a standard css style sheet for reports.
static QString	showSettings ()
	Convenience function to get a summary of the paths used in this application instance useful for debugging mainly.
static void	registerOgrDrivers ()
	Register OGR drivers ensuring this only happens once.
static QString	absolutePathToRelativePath (QString apath, QString targetPath)
	Converts absolute path to path relative to target.
static QString	relativePathToAbsolutePath (QString rpath, QString targetPath)
	Converts path relative to target to an absolute path.
Static Private Attributes
static QString	mPrefixPath
static QString	mPluginPath
static QString	mPkgDataPath
static QString	mThemeName
static QStringList	mDefaultSvgPaths
static QString	mConfigPath = QDir::homePath() + QString( "/.qgis/" )

void QgsApplication::setPrefixPath	(	const QString	thePrefixPath,
		bool	useDefaultPaths = `false`
	)			`[static]`

QString QgsApplication::absolutePathToRelativePath	(	QString	apath,
		QString	targetPath
	)			`[static]`

QString QgsApplication::relativePathToAbsolutePath	(	QString	rpath,
		QString	targetPath
	)			`[static]`

QgsApplication Class Reference [QGIS core library]

Public Types

Public Member Functions

Static Public Member Functions