Quantum GIS API Documentation
1.7.4
|
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 | |
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 | 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 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 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 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 (mThemeName) |
static QStringList | ABISYM (mDefaultSvgPaths) |
static QString | ABISYM (mConfigPath) |
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 29 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 60 of file qgsapplication.cpp.
References qgisSettingsDirPath(), and setPrefixPath().
QgsApplication::~QgsApplication | ( | ) | [virtual] |
Definition at line 80 of file qgsapplication.cpp.
static QObject* QgsApplication::ABISYM | ( | mFileOpenEventReceiver | ) | [static, private] |
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 | ( | mThemeName | ) | [static, private] |
static QStringList QgsApplication::ABISYM | ( | mDefaultSvgPaths | ) | [static, private] |
static QString QgsApplication::ABISYM | ( | mConfigPath | ) | [static, private] |
QString QgsApplication::absolutePathToRelativePath | ( | QString | apath, |
QString | targetPath | ||
) | [static] |
Converts absolute path to path relative to target.
Definition at line 517 of file qgsapplication.cpp.
const QString QgsApplication::activeThemePath | ( | ) | [static] |
Returns the path to the currently active theme directory.
Definition at line 203 of file qgsapplication.cpp.
Referenced by QgsComposerItem::drawSelectionBoxes(), iconPath(), QgsRasterLayer::legendAsPixmap(), QgsProjectionSelector::loadCrsList(), QgsProjectionSelector::loadUserCrsList(), QgsComposerSymbolItem::readXML(), and showSettings().
const QString QgsApplication::authorsFilePath | ( | ) | [static] |
Returns the path to the authors file.
Definition at line 246 of file qgsapplication.cpp.
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 253 of file qgsapplication.cpp.
const QString QgsApplication::defaultStyleV2Path | ( | ) | [static] |
Returns the path to default style (works as a starting point). Added in QGIS 1.4.
Definition at line 390 of file qgsapplication.cpp.
Referenced by QgsStyleV2::defaultStyle().
const QString QgsApplication::defaultThemePath | ( | ) | [static] |
Returns the path to the default theme directory.
Definition at line 199 of file qgsapplication.cpp.
Referenced by QgsComposerItem::drawSelectionBoxes(), iconPath(), and showSettings().
const QString QgsApplication::developerPath | ( | ) | [static] |
Returns the path to the developer image directory.
Definition at line 284 of file qgsapplication.cpp.
const QString QgsApplication::donorsFilePath | ( | ) | [static] |
Returns the path to the donors file.
Definition at line 268 of file qgsapplication.cpp.
QgsApplication::endian_t QgsApplication::endian | ( | ) | [static] |
Returns whether this machine uses big or little endian.
Definition at line 395 of file qgsapplication.cpp.
Referenced by QgsGeometry::convertToMultiType(), and QgsGeometry::exportGeosToWkb().
bool QgsApplication::event | ( | QEvent * | event | ) | [virtual] |
void QgsApplication::exitQgis | ( | ) | [static] |
deletes provider registry and map layer registry
Definition at line 409 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 292 of file qgsapplication.cpp.
References prefixPath().
Referenced by QgsContextHelp::start().
const QString QgsApplication::i18nPath | ( | ) | [static] |
Returns the path to the translation directory.
Definition at line 306 of file qgsapplication.cpp.
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 209 of file qgsapplication.cpp.
References activeThemePath(), and defaultThemePath().
const QString QgsApplication::iconsPath | ( | ) | [static] |
Returns the path to the icons image directory.
Definition at line 346 of file qgsapplication.cpp.
void QgsApplication::initQgis | ( | ) | [static] |
loads providers
Definition at line 400 of file qgsapplication.cpp.
References QgsMapLayerRegistry::instance(), QgsProviderRegistry::instance(), and pluginPath().
bool QgsApplication::notify | ( | QObject * | receiver, |
QEvent * | event | ||
) | [virtual] |
Catch exceptions when sending event to receiver.
Definition at line 112 of file qgsapplication.cpp.
References QgsException::what().
Referenced by event().
const QString QgsApplication::pkgDataPath | ( | ) | [static] |
Returns the common root path of all application data directories.
Definition at line 195 of file qgsapplication.cpp.
Referenced by QgsMapLayer::loadNamedStyle().
const QString QgsApplication::pluginPath | ( | ) | [static] |
Returns the path to the application plugin directory.
Definition at line 191 of file qgsapplication.cpp.
Referenced by initQgis().
const QString QgsApplication::prefixPath | ( | ) | [static] |
Returns the path to the application prefix directory.
Definition at line 187 of file qgsapplication.cpp.
Referenced by helpAppPath().
const QString QgsApplication::qgisMasterDbFilePath | ( | ) | [static] |
Returns the path to the master qgis.db file.
Definition at line 314 of file qgsapplication.cpp.
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 322 of file qgsapplication.cpp.
Referenced by QgsMapLayer::loadNamedStyle(), qgisUserDbFilePath(), QgsApplication(), QgsMapLayer::saveNamedStyle(), and userStyleV2Path().
const QString QgsApplication::qgisUserDbFilePath | ( | ) | [static] |
Returns the path to the user qgis.db file.
Definition at line 330 of file qgsapplication.cpp.
References qgisSettingsDirPath().
Referenced by QgsCoordinateReferenceSystem::createFromSrsId(), QgsCoordinateReferenceSystem::findMatchingProj(), QgsProjectionSelector::getLargestCRSIDMatch(), QgsCoordinateReferenceSystem::getRecord(), QgsCoordinateReferenceSystem::getRecordCount(), QgsProjectionSelector::getSelectedExpression(), QgsProjectionSelector::loadUserCrsList(), QgsProjectionSelector::on_pbnFind_clicked(), 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 509 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 580 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 437 of file qgsapplication.cpp.
void QgsApplication::setDefaultSvgPaths | ( | const QStringList & | pathList | ) | [static] |
Alters default svg paths - used by 3rd party apps. Added in QGIS 1.5.
Definition at line 182 of file qgsapplication.cpp.
void QgsApplication::setFileOpenEventReceiver | ( | QObject * | receiver | ) | [static] |
Set the FileOpen event receiver.
Definition at line 135 of file qgsapplication.cpp.
void QgsApplication::setPkgDataPath | ( | const QString | thePkgDataPath | ) | [static] |
Alters pkg data path - used by 3rd party apps.
Definition at line 173 of file qgsapplication.cpp.
References svgPath().
Referenced by setPrefixPath().
void QgsApplication::setPluginPath | ( | const QString | thePluginPath | ) | [static] |
Alters plugin path - used by 3rd party apps.
Definition at line 168 of file qgsapplication.cpp.
Referenced by setPrefixPath().
void QgsApplication::setPrefixPath | ( | const QString | thePrefixPath, |
bool | useDefaultPaths = false |
||
) | [static] |
Alters prefix path - used by 3rd party apps.
Definition at line 152 of file qgsapplication.cpp.
References setPkgDataPath(), and setPluginPath().
Referenced by QgsApplication().
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 223 of file qgsapplication.cpp.
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 415 of file qgsapplication.cpp.
References activeThemePath(), defaultThemePath(), qgisMasterDbFilePath(), svgPaths(), and themeName().
const QString QgsApplication::splashPath | ( | ) | [static] |
Returns the path to the splash screen image directory.
Definition at line 338 of file qgsapplication.cpp.
const QString QgsApplication::sponsorsFilePath | ( | ) | [static] |
Returns the path to the sponsors file.
Definition at line 260 of file qgsapplication.cpp.
const QString QgsApplication::srsDbFilePath | ( | ) | [static] |
Returns the path to the srs.db file.
Definition at line 353 of file qgsapplication.cpp.
Referenced by QgsCoordinateReferenceSystem::createFromOgcWmsCrs(), QgsCoordinateReferenceSystem::createFromSrid(), QgsCoordinateReferenceSystem::createFromSrsId(), QgsCoordinateReferenceSystem::findMatchingProj(), QgsCoordinateReferenceSystem::getRecord(), QgsCoordinateReferenceSystem::proj4FromSrsId(), QgsProjectionSelector::QgsProjectionSelector(), and QgsDistanceArea::setEllipsoid().
const QString QgsApplication::svgPath | ( | ) | [static] |
Returns the paths to svg applications svg directory.
Returns the path to the applications svg directories.
Definition at line 380 of file qgsapplication.cpp.
Referenced by setPkgDataPath().
const QStringList QgsApplication::svgPaths | ( | ) | [static] |
Returns the pathes to svg directories.
Returns the paths to the svg directories.
Definition at line 361 of file qgsapplication.cpp.
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 239 of file qgsapplication.cpp.
Referenced by showSettings().
const QString QgsApplication::translatorsFilePath | ( | ) | [static] |
Returns the path to the sponsors file.
Returns the path to the sponsors file.
Definition at line 277 of file qgsapplication.cpp.
const QString QgsApplication::userStyleV2Path | ( | ) | [static] |
Returns the path to user's style. Added in QGIS 1.4.
Definition at line 385 of file qgsapplication.cpp.
References qgisSettingsDirPath().
Referenced by QgsStyleV2::defaultStyle().