Quantum GIS API Documentation
1.8
|
Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc. More...
#include <qgsapplication.h>
Public Types | |
enum | ENDIAN { XDR = 0, NDR = 1 } |
constants for endian-ness More... | |
typedef enum QgsApplication::ENDIAN | endian_t |
constants for endian-ness | |
Signals | |
void | preNotify (QObject *receiver, QEvent *event, bool *done) |
Public Member Functions | |
QgsApplication (int &argc, char **argv, bool GUIenabled, QString customConfigPath=QString()) | |
virtual | ~QgsApplication () |
virtual bool | event (QEvent *event) |
Watch for QFileOpenEvent. | |
virtual bool | notify (QObject *receiver, QEvent *event) |
Catch exceptions when sending event to receiver. | |
Static Public Member Functions | |
static void | init (QString customConfigPath=QString()) |
This method initialises paths etc for QGIS. | |
static void | setFileOpenEventReceiver (QObject *receiver) |
Set the FileOpen event receiver. | |
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 Q_DECL_DEPRECATED 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 | i18nPath () |
Returns the path to the translation directory. | |
static const QString | qgisMasterDbFilePath () |
Returns the path to the master qgis.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 Q_DECL_DEPRECATED 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 const QString | libraryPath () |
Returns the path containing qgis_core, qgis_gui, qgispython (and other) libraries. | |
static const QString | libexecPath () |
Returns the path with utility executables (help viewer, crssync, ...) | |
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 bool | isRunningFromBuildDir () |
Indicates whether running from build directory (not installed) | |
static QString | buildSourcePath () |
Returns path to the source directory. | |
static QString | buildOutputPath () |
Returns path to the build output directory. | |
static void | skipGdalDriver (QString theDriver) |
Sets the GDAL_SKIP environment variable to include the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. | |
static void | restoreGdalDriver (QString theDriver) |
Sets the GDAL_SKIP environment variable to exclude the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. | |
static QStringList | skippedGdalDrivers () |
Returns the list of gdal drivers that should be skipped (based on GDAL_SKIP environment variable) | |
static void | applyGdalSkippedDrivers () |
Apply the skipped drivers list to gdal. | |
Static Private Member Functions | |
static QObject * | ABISYM (mFileOpenEventReceiver) |
static QStringList | ABISYM (mFileOpenEventList) |
static QString | ABISYM (mPrefixPath) |
static QString | ABISYM (mPluginPath) |
static QString | ABISYM (mPkgDataPath) |
static QString | ABISYM (mLibraryPath) |
static QString | ABISYM (mLibexecPath) |
static QString | ABISYM (mThemeName) |
static QStringList | ABISYM (mDefaultSvgPaths) |
static QString | ABISYM (mConfigPath) |
static bool | ABISYM (mRunningFromBuildDir) |
true when running from build directory, i.e. | |
static QString | ABISYM (mBuildSourcePath) |
path to the source directory. | |
static QString | ABISYM (mBuildOutputPath) |
path to the output directory of the build. | |
static QStringList | ABISYM (mGdalSkipList) |
List of gdal drivers to be skipped. |
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 30 of file qgsapplication.h.
typedef enum QgsApplication::ENDIAN QgsApplication::endian_t |
constants for endian-ness
QgsApplication::QgsApplication | ( | int & | argc, |
char ** | argv, | ||
bool | GUIenabled, | ||
QString | customConfigPath = QString() |
||
) |
Definition at line 73 of file qgsapplication.cpp.
References init().
QgsApplication::~QgsApplication | ( | ) | [virtual] |
Definition at line 168 of file qgsapplication.cpp.
static QObject* QgsApplication::ABISYM | ( | mFileOpenEventReceiver | ) | [static, private] |
Referenced by authorsFilePath(), contributorsFilePath(), defaultStyleV2Path(), donorsFilePath(), event(), i18nPath(), iconsPath(), init(), libexecPath(), libraryPath(), pkgDataPath(), pluginPath(), prefixPath(), qgisMasterDbFilePath(), qgisSettingsDirPath(), setDefaultSvgPaths(), setFileOpenEventReceiver(), setPkgDataPath(), setPluginPath(), setPrefixPath(), setThemeName(), sponsorsFilePath(), srsDbFilePath(), svgPath(), svgPaths(), themeName(), and translatorsFilePath().
static QStringList QgsApplication::ABISYM | ( | mFileOpenEventList | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mPrefixPath | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mPluginPath | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mPkgDataPath | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mLibraryPath | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mLibexecPath | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mThemeName | ) | [static, private] |
static QStringList QgsApplication::ABISYM | ( | mDefaultSvgPaths | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mConfigPath | ) | [static, private] |
static bool QgsApplication::ABISYM | ( | mRunningFromBuildDir | ) | [static, private] |
true when running from build directory, i.e.
without 'make install'
static QString QgsApplication::ABISYM | ( | mBuildSourcePath | ) | [static, private] |
path to the source directory.
valid only when running from build directory.
static QString QgsApplication::ABISYM | ( | mBuildOutputPath | ) | [static, private] |
path to the output directory of the build.
valid only when running from build directory
static QStringList QgsApplication::ABISYM | ( | mGdalSkipList | ) | [static, private] |
List of gdal drivers to be skipped.
Uses GDAL_SKIP to exclude them.
QString QgsApplication::absolutePathToRelativePath | ( | QString | apath, |
QString | targetPath | ||
) | [static] |
Converts absolute path to path relative to target.
Definition at line 670 of file qgsapplication.cpp.
const QString QgsApplication::activeThemePath | ( | ) | [static] |
Returns the path to the currently active theme directory.
Definition at line 307 of file qgsapplication.cpp.
References themeName().
Referenced by QgsComposerItem::drawSelectionBoxes(), QgsDataItem::getThemePixmap(), icon(), iconPath(), QgsRasterLayer::legendAsPixmap(), QgsProjectionSelector::loadCrsList(), QgsProjectionSelector::loadUserCrsList(), QgsComposerSymbolItem::readXML(), and showSettings().
static void QgsApplication::applyGdalSkippedDrivers | ( | ) | [static] |
Apply the skipped drivers list to gdal.
const QString QgsApplication::authorsFilePath | ( | ) | [static] |
Returns the path to the authors file.
Definition at line 350 of file qgsapplication.cpp.
References ABISYM().
static QString QgsApplication::buildOutputPath | ( | ) | [inline, static] |
Returns path to the build output directory.
Valid only when running from build directory
Definition at line 233 of file qgsapplication.h.
References ABISYM.
static QString QgsApplication::buildSourcePath | ( | ) | [inline, static] |
Returns path to the source directory.
Valid only when running from build directory
Definition at line 230 of file qgsapplication.h.
References ABISYM.
const QString QgsApplication::contributorsFilePath | ( | ) | [static] |
Returns the path to the contributors file.
Contributors are people who have submitted patches but don't have svn write access.
Definition at line 357 of file qgsapplication.cpp.
References ABISYM().
const QString QgsApplication::defaultStyleV2Path | ( | ) | [static] |
Returns the path to default style (works as a starting point). Added in QGIS 1.4.
Definition at line 514 of file qgsapplication.cpp.
References ABISYM().
Referenced by QgsStyleV2::defaultStyle().
const QString QgsApplication::defaultThemePath | ( | ) | [static] |
Returns the path to the default theme directory.
Definition at line 303 of file qgsapplication.cpp.
Referenced by QgsComposerItem::drawSelectionBoxes(), QgsDataItem::getThemePixmap(), icon(), iconPath(), and showSettings().
const QString QgsApplication::developerPath | ( | ) | [static] |
Returns the path to the developer image directory.
Definition at line 386 of file qgsapplication.cpp.
const QString QgsApplication::donorsFilePath | ( | ) | [static] |
Returns the path to the donors file.
Definition at line 372 of file qgsapplication.cpp.
References ABISYM().
QgsApplication::endian_t QgsApplication::endian | ( | ) | [static] |
Returns whether this machine uses big or little endian.
Definition at line 529 of file qgsapplication.cpp.
Referenced by QgsGeometry::convertToMultiType(), and QgsGeometry::exportGeosToWkb().
bool QgsApplication::event | ( | QEvent * | event | ) | [virtual] |
Watch for QFileOpenEvent.
Definition at line 172 of file qgsapplication.cpp.
void QgsApplication::exitQgis | ( | ) | [static] |
deletes provider registry and map layer registry
Definition at line 543 of file qgsapplication.cpp.
References QgsMapLayerRegistry::instance(), and QgsProviderRegistry::instance().
const QString QgsApplication::helpAppPath | ( | ) | [static] |
Returns the path to the help application.
Definition at line 394 of file qgsapplication.cpp.
References libexecPath().
Referenced by QgsContextHelp::start().
const QString QgsApplication::i18nPath | ( | ) | [static] |
Returns the path to the translation directory.
Definition at line 408 of file qgsapplication.cpp.
References ABISYM().
QString QgsApplication::iconPath | ( | QString | iconFile | ) | [static] |
Returns path to the desired icon file.
First it tries to use the active theme path, then default theme path
Definition at line 313 of file qgsapplication.cpp.
References activeThemePath(), and defaultThemePath().
const QString QgsApplication::iconsPath | ( | ) | [static] |
Returns the path to the icons image directory.
Definition at line 451 of file qgsapplication.cpp.
References ABISYM().
void QgsApplication::init | ( | QString | customConfigPath = QString() | ) | [static] |
This method initialises paths etc for QGIS.
Called by the ctor or call it manually when your app does not extend the QApplication class.
Definition at line 78 of file qgsapplication.cpp.
References ABISYM(), qgisSettingsDirPath(), setPkgDataPath(), setPluginPath(), setPrefixPath(), and SOURCE_PATH.
Referenced by QgsApplication().
void QgsApplication::initQgis | ( | ) | [static] |
loads providers
Definition at line 534 of file qgsapplication.cpp.
References QgsMapLayerRegistry::instance(), QgsProviderRegistry::instance(), and pluginPath().
static bool QgsApplication::isRunningFromBuildDir | ( | ) | [inline, static] |
Indicates whether running from build directory (not installed)
Definition at line 224 of file qgsapplication.h.
References ABISYM.
const QString QgsApplication::libexecPath | ( | ) | [static] |
Returns the path with utility executables (help viewer, crssync, ...)
Definition at line 524 of file qgsapplication.cpp.
References ABISYM().
Referenced by helpAppPath().
const QString QgsApplication::libraryPath | ( | ) | [static] |
Returns the path containing qgis_core, qgis_gui, qgispython (and other) libraries.
Definition at line 519 of file qgsapplication.cpp.
References ABISYM().
bool QgsApplication::notify | ( | QObject * | receiver, |
QEvent * | event | ||
) | [virtual] |
Catch exceptions when sending event to receiver.
Definition at line 200 of file qgsapplication.cpp.
References preNotify(), and QgsException::what().
Referenced by event().
const QString QgsApplication::pkgDataPath | ( | ) | [static] |
Returns the common root path of all application data directories.
Definition at line 299 of file qgsapplication.cpp.
References ABISYM().
Referenced by QgsExpressionBuilderWidget::loadFunctionHelp(), QgsMapLayer::loadNamedStyle(), and showSettings().
const QString QgsApplication::pluginPath | ( | ) | [static] |
Returns the path to the application plugin directory.
Definition at line 295 of file qgsapplication.cpp.
References ABISYM().
Referenced by initQgis(), and showSettings().
const QString QgsApplication::prefixPath | ( | ) | [static] |
Returns the path to the application prefix directory.
Definition at line 286 of file qgsapplication.cpp.
References ABISYM().
Referenced by showSettings().
void QgsApplication::preNotify | ( | QObject * | receiver, |
QEvent * | event, | ||
bool * | done | ||
) | [signal] |
Referenced by notify().
const QString QgsApplication::qgisMasterDbFilePath | ( | ) | [static] |
Returns the path to the master qgis.db file.
Definition at line 419 of file qgsapplication.cpp.
References ABISYM().
Referenced by showSettings().
const QString QgsApplication::qgisSettingsDirPath | ( | ) | [static] |
Returns the path to the settings directory in user's home dir.
Returns the path to the settings directory in user's home dir
Definition at line 427 of file qgsapplication.cpp.
References ABISYM().
Referenced by init(), QgsMapLayer::loadNamedStyle(), qgisUserDbFilePath(), QgsMapLayer::saveNamedStyle(), and userStyleV2Path().
const QString QgsApplication::qgisUserDbFilePath | ( | ) | [static] |
Returns the path to the user qgis.db file.
Definition at line 435 of file qgsapplication.cpp.
References qgisSettingsDirPath().
Referenced by QgsCoordinateReferenceSystem::createFromSrsId(), QgsCoordinateReferenceSystem::findMatchingProj(), QgsProjectionSelector::getLargestCRSIDMatch(), QgsCoordinateReferenceSystem::getRecord(), QgsCoordinateReferenceSystem::getRecordCount(), QgsProjectionSelector::getSelectedExpression(), QgsProjectionSelector::loadUserCrsList(), QgsCoordinateReferenceSystem::proj4FromSrsId(), QgsCoordinateReferenceSystem::saveAsUserCRS(), and QgsProjectionSelector::selectedProj4String().
void QgsApplication::registerOgrDrivers | ( | ) | [static] |
Register OGR drivers ensuring this only happens once.
This is a workaround for an issue with older gdal versions that caused duplicate driver name entries to appear in the list of registered drivers when QgsApplication::registerOgrDrivers was called multiple times.
Definition at line 662 of file qgsapplication.cpp.
Referenced by QgsVectorFileWriter::ogrDriverList(), QgsVectorFileWriter::QgsVectorFileWriter(), and QgsVectorFileWriter::supportedFiltersAndFormats().
QString QgsApplication::relativePathToAbsolutePath | ( | QString | rpath, |
QString | targetPath | ||
) | [static] |
Converts path relative to target to an absolute path.
Definition at line 733 of file qgsapplication.cpp.
QString QgsApplication::reportStyleSheet | ( | ) | [static] |
get a standard css style sheet for reports.
Typically you will use this method by doing: QString myStyle = QgsApplication::reportStyleSheet(); textBrowserReport->document()->setDefaultStyleSheet(myStyle);
Definition at line 571 of file qgsapplication.cpp.
Referenced by QgsExpressionBuilderWidget::loadFunctionHelp(), and QgsGenericProjectionSelector::setMessage().
static void QgsApplication::restoreGdalDriver | ( | QString | theDriver | ) | [static] |
Sets the GDAL_SKIP environment variable to exclude the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it.
The driver name should be the short format of the Gdal driver name e.g. GTIFF.
void QgsApplication::setDefaultSvgPaths | ( | const QStringList & | pathList | ) | [static] |
Alters default svg paths - used by 3rd party apps. Added in QGIS 1.5.
Definition at line 281 of file qgsapplication.cpp.
References ABISYM().
void QgsApplication::setFileOpenEventReceiver | ( | QObject * | receiver | ) | [static] |
Set the FileOpen event receiver.
Definition at line 232 of file qgsapplication.cpp.
References ABISYM().
void QgsApplication::setPkgDataPath | ( | const QString | thePkgDataPath | ) | [static] |
Alters pkg data path - used by 3rd party apps.
Definition at line 272 of file qgsapplication.cpp.
References ABISYM().
Referenced by init(), and setPrefixPath().
void QgsApplication::setPluginPath | ( | const QString | thePluginPath | ) | [static] |
Alters plugin path - used by 3rd party apps.
Definition at line 267 of file qgsapplication.cpp.
References ABISYM().
Referenced by init(), and setPrefixPath().
void QgsApplication::setPrefixPath | ( | const QString | thePrefixPath, |
bool | useDefaultPaths = false |
||
) | [static] |
Alters prefix path - used by 3rd party apps.
Definition at line 249 of file qgsapplication.cpp.
References ABISYM(), setPkgDataPath(), and setPluginPath().
Referenced by init().
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.
Set the theme path to the specified theme.
Definition at line 327 of file qgsapplication.cpp.
References ABISYM().
QString QgsApplication::showSettings | ( | ) | [static] |
Convenience function to get a summary of the paths used in this application instance useful for debugging mainly.
Definition at line 549 of file qgsapplication.cpp.
References activeThemePath(), defaultThemePath(), pkgDataPath(), pluginPath(), prefixPath(), qgisMasterDbFilePath(), svgPaths(), and themeName().
static void QgsApplication::skipGdalDriver | ( | QString | theDriver | ) | [static] |
Sets the GDAL_SKIP environment variable to include the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it.
The driver name should be the short format of the Gdal driver name e.g. GTIFF.
static QStringList QgsApplication::skippedGdalDrivers | ( | ) | [inline, static] |
Returns the list of gdal drivers that should be skipped (based on GDAL_SKIP environment variable)
Definition at line 253 of file qgsapplication.h.
References ABISYM.
const QString QgsApplication::splashPath | ( | ) | [static] |
Returns the path to the splash screen image directory.
Definition at line 443 of file qgsapplication.cpp.
const QString QgsApplication::sponsorsFilePath | ( | ) | [static] |
Returns the path to the sponsors file.
Definition at line 364 of file qgsapplication.cpp.
References ABISYM().
const QString QgsApplication::srsDbFilePath | ( | ) | [static] |
Returns the path to the srs.db file.
Definition at line 458 of file qgsapplication.cpp.
References ABISYM().
Referenced by QgsCoordinateReferenceSystem::createFromOgcWmsCrs(), QgsCoordinateReferenceSystem::createFromSrid(), QgsCoordinateReferenceSystem::createFromSrsId(), QgsCoordinateReferenceSystem::findMatchingProj(), QgsCoordinateReferenceSystem::getRecord(), QgsCoordinateReferenceSystem::proj4FromSrsId(), QgsProjectionSelector::QgsProjectionSelector(), QgsDistanceArea::setEllipsoid(), and QgsCoordinateReferenceSystem::syncDb().
const QString QgsApplication::svgPath | ( | ) | [static] |
Returns the paths to svg applications svg directory.
Returns the path to the applications svg directories.
Definition at line 503 of file qgsapplication.cpp.
References ABISYM().
const QStringList QgsApplication::svgPaths | ( | ) | [static] |
Returns the pathes to svg directories.
Returns the paths to the svg directories.
Definition at line 484 of file qgsapplication.cpp.
References ABISYM().
Referenced by QgsSvgMarkerSymbolLayerV2::listSvgFiles(), QgsMarkerCatalogue::refreshList(), QgsSymbol::setNamedPointSymbol(), showSettings(), QgsSvgMarkerSymbolLayerV2::symbolNameToPath(), QgsSvgMarkerSymbolLayerV2::symbolPathToName(), and QgsSymbol::writeXML().
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 343 of file qgsapplication.cpp.
References ABISYM().
Referenced by activeThemePath(), and showSettings().
const QString QgsApplication::translatorsFilePath | ( | ) | [static] |
Returns the path to the sponsors file.
Returns the path to the sponsors file.
Definition at line 381 of file qgsapplication.cpp.
References ABISYM().
const QString QgsApplication::userStyleV2Path | ( | ) | [static] |
Returns the path to user's style. Added in QGIS 1.4.
Definition at line 509 of file qgsapplication.cpp.
References qgisSettingsDirPath().
Referenced by QgsStyleV2::defaultStyle().