QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc. More...
#include <qgsapplication.h>
Public Types | |
enum | Cursor { ZoomIn , ZoomOut , Identify , CrossHair , CapturePoint , Select , Sampler } |
The Cursor enum defines constants for QGIS custom cursors. More... | |
enum | endian_t { XDR = 0 , NDR = 1 } |
Constants for endian-ness. More... | |
enum | StyleSheetType { Qt , WebBrowser } |
The StyleSheetType enum represents the stylesheet type that a widget supports. More... | |
Signals | |
void | customVariablesChanged () |
Emitted whenever a custom global variable changes. More... | |
void | localeChanged () |
Emitted when project locale has been changed. More... | |
void | nullRepresentationChanged () |
This string is used to represent the value NULL throughout QGIS. More... | |
void | preNotify (QObject *receiver, QEvent *event, bool *done) |
void | requestForTranslatableObjects (QgsTranslationContext *translationContext) |
Emitted when project strings which require translation are being collected for inclusion in a .ts file. More... | |
Public Member Functions | |
QgsApplication (int &argc, char **argv, bool GUIenabled, const QString &profileFolder=QString(), const QString &platformName="external") | |
Constructor for QgsApplication. More... | |
~QgsApplication () override | |
void | collectTranslatableObjects (QgsTranslationContext *translationContext) |
Emits the signal to collect all the strings of .qgs to be included in ts file. More... | |
bool | event (QEvent *event) override |
Watch for QFileOpenEvent. More... | |
int | maxConcurrentConnectionsPerPool () const |
The maximum number of concurrent connections per connections pool. More... | |
bool | notify (QObject *receiver, QEvent *event) override |
Catch exceptions when sending event to receiver. More... | |
QString | translation () const |
Returns the current application translation locale code. More... | |
Static Public Member Functions | |
static QString | absolutePathToRelativePath (const QString &apath, const QString &targetPath) |
Converts absolute path to path relative to target. More... | |
static QgsActionScopeRegistry * | actionScopeRegistry () |
Returns the action scope registry. More... | |
static QString | activeThemePath () |
Returns the path to the currently active theme directory. More... | |
static QgsAnnotationItemRegistry * | annotationItemRegistry () |
Returns the application's annotation item registry, used for annotation item types. More... | |
static QgsAnnotationRegistry * | annotationRegistry () |
Returns the application's annotation registry, used for managing annotation types. More... | |
static QString | appIconPath () |
Gets application icon. More... | |
static void | applyGdalSkippedDrivers () |
Apply the skipped drivers list to gdal. More... | |
static QgsAuthManager * | authManager () |
Returns the application's authentication manager instance. More... | |
static QString | authorsFilePath () |
Returns the path to the authors file. More... | |
static QgsBookmarkManager * | bookmarkManager () |
Returns the application's bookmark manager, used for storing installation-wide bookmarks. More... | |
static QString | buildOutputPath () |
Returns path to the build output directory. Valid only when running from build directory. More... | |
static QString | buildSourcePath () |
Returns path to the source directory. Valid only when running from build directory. More... | |
static QgsCalloutRegistry * | calloutRegistry () |
Returns the application's callout registry, used for managing callout types. More... | |
static QgsClassificationMethodRegistry * | classificationMethodRegistry () |
Returns the application's classification methods registry, used in graduated renderer. More... | |
static QgsColorSchemeRegistry * | colorSchemeRegistry () |
Returns the application's color scheme registry, used for managing color schemes. More... | |
static QgsConnectionRegistry * | connectionRegistry () |
Returns the application's connection registry, used for managing saved data provider connections. More... | |
static QString | contributorsFilePath () |
Returns the path to the contributors file. More... | |
static QgsCoordinateReferenceSystemRegistry * | coordinateReferenceSystemRegistry () |
Returns the application's coordinate reference system (CRS) registry, which handles known CRS definitions (including user-defined CRSes). More... | |
static bool | createDatabase (QString *errorMessage=nullptr) |
initialize qgis.db More... | |
static bool | createThemeFolder () |
Create the users theme folder. More... | |
static QVariantMap | customVariables () |
Custom expression variables for this application. More... | |
static QgsDataItemProviderRegistry * | dataItemProviderRegistry () |
Returns the application's data item provider registry, which keeps a list of data item providers that may add items to the browser tree. More... | |
static QgsStyleModel * | defaultStyleModel () |
Returns a shared QgsStyleModel containing the default style library (see QgsStyle::defaultStyle()). More... | |
static QString | defaultStylePath () |
Returns the path to default style (works as a starting point). More... | |
static QString | defaultThemePath () |
Returns the path to the default theme directory. More... | |
static QString | defaultThemesFolder () |
Returns the path to default themes folder from install (works as a starting point). More... | |
static QStringList | deferredSkippedGdalDrivers () |
Returns the list of gdal drivers that have been disabled in the current session, and thus, for safety, should not be disabled right now, but at the next application restart. More... | |
static QString | developersMapFilePath () |
Returns the path to the developers map file. More... | |
static QString | donorsFilePath () |
Returns the path to the donors file. More... | |
static endian_t | endian () |
Returns whether this machine uses big or little endian. More... | |
static void | exitQgis () |
deletes provider registry and map layer registry More... | |
static QgsExternalStorageRegistry * | externalStorageRegistry () |
Returns registry of available external storage implementations. More... | |
static QgsFieldFormatterRegistry * | fieldFormatterRegistry () |
Gets the registry of available field formatters. More... | |
static QCursor | getThemeCursor (Cursor cursor) |
Helper to get a theme cursor. More... | |
static QIcon | getThemeIcon (const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor()) |
Helper to get a theme icon. More... | |
static QPixmap | getThemePixmap (const QString &name, const QColor &foreColor=QColor(), const QColor &backColor=QColor(), int size=16) |
Helper to get a theme icon as a pixmap. More... | |
static QgsBabelFormatRegistry * | gpsBabelFormatRegistry () |
Returns the application's GPSBabel format registry, used for managing GPSBabel formats. More... | |
static QgsGpsConnectionRegistry * | gpsConnectionRegistry () |
Returns the application's GPS connection registry, used for managing GPS connections. More... | |
static QString | i18nPath () |
Returns the path to the translation directory. More... | |
static QString | iconPath (const QString &iconFile) |
Returns path to the desired icon file. More... | |
static QString | iconsPath () |
Returns the path to the icons image directory. More... | |
static QgsImageCache * | imageCache () |
Returns the application's image cache, used for caching resampled versions of raster images. More... | |
static void | init (QString profileFolder=QString()) |
This method initializes paths etc for QGIS. More... | |
static void | initQgis () |
loads providers More... | |
static QgsApplication * | instance () |
Returns the singleton instance of the QgsApplication. More... | |
static bool | isRunningFromBuildDir () |
Indicates whether running from build directory (not installed) More... | |
static QgsLayoutItemRegistry * | layoutItemRegistry () |
Returns the application's layout item registry, used for layout item types. More... | |
static QStringList | layoutTemplatePaths () |
Returns the paths to layout template directories. More... | |
static QString | libexecPath () |
Returns the path with utility executables (help viewer, crssync, ...) More... | |
static QString | libraryPath () |
Returns the path containing qgis_core, qgis_gui, qgispython (and other) libraries. More... | |
static QString | licenceFilePath () |
Returns the path to the licence file. More... | |
static QString | locale () |
Returns the QGIS locale. More... | |
static QgsLocalizedDataPathRegistry * | localizedDataPathRegistry () |
Returns the registry of data repositories These are used as paths for basemaps, logos, etc. More... | |
static int | maxThreads () |
Gets maximum concurrent thread count. More... | |
static QgsMessageLog * | messageLog () |
Returns the application's message log. More... | |
static QString | metadataPath () |
Returns the path to the metadata directory. More... | |
static QgsNetworkContentFetcherRegistry * | networkContentFetcherRegistry () |
Returns the application's network content registry used for fetching temporary files during QGIS session. More... | |
static QString | nullRepresentation () |
This string is used to represent the value NULL throughout QGIS. More... | |
static QgsNumericFormatRegistry * | numericFormatRegistry () |
Gets the registry of available numeric formats. More... | |
static QString | osName () |
Returns a string name of the operating system QGIS is running on. More... | |
static QgsPageSizeRegistry * | pageSizeRegistry () |
Returns the application's page size registry, used for managing layout page sizes. More... | |
static QgsPaintEffectRegistry * | paintEffectRegistry () |
Returns the application's paint effect registry, used for managing paint effects. More... | |
static QString | pkgDataPath () |
Returns the common root path of all application data directories. More... | |
static QString | platform () |
Returns the QGIS platform name, e.g., "desktop", "server", "qgis_process" or "external" (for external CLI scripts). More... | |
static QgsPluginLayerRegistry * | pluginLayerRegistry () |
Returns the application's plugin layer registry, used for managing plugin layer types. More... | |
static QString | pluginPath () |
Returns the path to the application plugin directory. More... | |
static QgsPointCloudRendererRegistry * | pointCloudRendererRegistry () |
Returns the application's point cloud renderer registry, used for managing point cloud layer 2D renderers. More... | |
static QString | prefixPath () |
Returns the path to the application prefix directory. More... | |
static QgsProcessingRegistry * | processingRegistry () |
Returns the application's processing registry, used for managing processing providers, algorithms, and various parameters and outputs. More... | |
static QgsRuntimeProfiler * | profiler () |
Returns the application runtime profiler. More... | |
static QgsProjectStorageRegistry * | projectStorageRegistry () |
Returns registry of available project storage implementations. More... | |
static QString | qgisAuthDatabaseFilePath () |
Returns the path to the user authentication database file: qgis-auth.db. More... | |
static QString | qgisMasterDatabaseFilePath () |
Returns the path to the master qgis.db file. More... | |
static QString | qgisSettingsDirPath () |
Returns the path to the settings directory in user's home dir. More... | |
static QString | qgisUserDatabaseFilePath () |
Returns the path to the user qgis.db file. More... | |
static QString | qmlImportPath () |
Returns the path where QML components are installed for QGIS Quick library. More... | |
static QgsRasterRendererRegistry * | rasterRendererRegistry () |
Returns the application's raster renderer registry, used for managing raster layer renderers. More... | |
static QgsRecentStyleHandler * | recentStyleHandler () |
Returns the handler for recently used style items. More... | |
static void | registerGdalDriversFromSettings () |
Register gdal drivers, excluding the ones mentioned in "gdal/skipList" setting. More... | |
static void | registerOgrDrivers () |
Register OGR drivers ensuring this only happens once. More... | |
static QString | relativePathToAbsolutePath (const QString &rpath, const QString &targetPath) |
Converts path relative to target to an absolute path. More... | |
static Qgs3DRendererRegistry * | renderer3DRegistry () |
Returns registry of available 3D renderers. More... | |
static QgsRendererRegistry * | rendererRegistry () |
Returns the application's renderer registry, used for managing vector layer renderers. More... | |
static QString | reportStyleSheet (QgsApplication::StyleSheetType styleSheetType=QgsApplication::StyleSheetType::Qt) |
Returns a css style sheet for reports, the styleSheetType argument determines what type of stylesheet is supported by the widget. More... | |
static QString | resolvePkgPath () |
Calculate the application pkg path. More... | |
static void | restoreGdalDriver (const QString &driver) |
Sets the GDAL_SKIP environment variable to exclude the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. More... | |
static QgsScaleBarRendererRegistry * | scaleBarRendererRegistry () |
Gets the registry of available scalebar renderers. More... | |
static int | scaleIconSize (int standardSize, bool applyDevicePixelRatio=false) |
Scales an icon size to compensate for display pixel density, making the icon size hi-dpi friendly, whilst still resulting in pixel-perfect sizes for low-dpi displays. More... | |
static QString | serverResourcesPath () |
Returns the path to the server resources directory. More... | |
static void | setAuthDatabaseDirPath (const QString &authDbDirPath) |
Alters authentication data base directory path - used by 3rd party apps. More... | |
static void | setCustomVariable (const QString &name, const QVariant &value) |
Set a single custom expression variable. More... | |
static void | setCustomVariables (const QVariantMap &customVariables) |
Custom expression variables for this application. More... | |
static void | setDefaultSvgPaths (const QStringList &pathList) |
Alters default svg paths - used by 3rd party apps. More... | |
static void | setFileOpenEventReceiver (QObject *receiver) |
Sets the FileOpen event receiver. More... | |
static void | setLocale (const QLocale &locale) |
Sets the QGIS locale - used mainly by 3rd party apps and tests. More... | |
static void | setMaxThreads (int maxThreads) |
Set maximum concurrent thread count. More... | |
static void | setNullRepresentation (const QString &nullRepresentation) |
This string is used to represent the value NULL throughout QGIS. More... | |
static void | setPkgDataPath (const QString &pkgDataPath) |
Alters pkg data path - used by 3rd party apps. More... | |
static void | setPluginPath (const QString &pluginPath) |
Alters plugin path - used by 3rd party apps. More... | |
static void | setPrefixPath (const QString &prefixPath, bool useDefaultPaths=false) |
Alters prefix path - used by 3rd party apps. More... | |
static void | setSkippedGdalDrivers (const QStringList &skippedGdalDrivers, const QStringList &deferredSkippedGdalDrivers) |
Sets the list of gdal drivers that should be disabled (skippedGdalDrivers), but excludes for now the ones defines in deferredSkippedGdalDrivers. More... | |
static void | setSvgPaths (const QStringList &svgPaths) |
Sets the paths to svg directories and invalidates the svg path list cache. More... | |
static void | setThemeName (const QString &themeName) |
Set the active theme to the specified theme. More... | |
static QgsSettingsRegistryCore * | settingsRegistryCore () |
Returns the application's settings registry, used for managing application settings. More... | |
static void | setTranslation (const QString &translation) |
Set translation locale code. More... | |
static void | setUITheme (const QString &themeName) |
Set the current UI theme used to style the interface. More... | |
static QRegularExpression | shortNameRegularExpression () |
Returns the short name regular expression for line edit validator. More... | |
static QString | showSettings () |
Convenience function to get a summary of the paths used in this application instance useful for debugging mainly. More... | |
static void | skipGdalDriver (const QString &driver) |
Sets the GDAL_SKIP environment variable to include the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. More... | |
static QStringList | skippedGdalDrivers () |
Returns the list of gdal drivers that should be skipped (based on GDAL_SKIP environment variable) More... | |
static QgsSourceCache * | sourceCache () |
Returns the application's source cache, used for caching embedded and remote source strings as local files. More... | |
static QString | splashPath () |
Returns the path to the splash screen image directory. More... | |
static QString | sponsorsFilePath () |
Returns the path to the sponsors file. More... | |
static QString | srsDatabaseFilePath () |
Returns the path to the srs.db file. More... | |
static QgsSvgCache * | svgCache () |
Returns the application's SVG cache, used for caching SVG images and handling parameter replacement within SVG files. More... | |
static QStringList | svgPaths () |
Returns the paths to svg directories. More... | |
static Qgs3DSymbolRegistry * | symbol3DRegistry () |
Returns registry of available 3D symbols. More... | |
static QgsSymbolLayerRegistry * | symbolLayerRegistry () |
Returns the application's symbol layer registry, used for managing symbol layers. More... | |
static QMap< QString, QString > | systemEnvVars () |
Returns the system environment variables passed to application. More... | |
static QgsTaskManager * | taskManager () |
Returns the application's task manager, used for managing application wide background task handling. More... | |
static QString | themeName () |
Set the active theme to the specified theme. More... | |
static QgsTileDownloadManager * | tileDownloadManager () |
Returns the application's tile download manager, used for download of map tiles when rendering. More... | |
static QString | translatorsFilePath () |
Returns the path to the sponsors file. More... | |
static QHash< QString, QString > | uiThemes () |
All themes found in ~/.qgis3/themes folder. More... | |
static QString | userFullName () |
Returns the user's operating system login account full display name. More... | |
static QString | userLoginName () |
Returns the user's operating system login account name. More... | |
static QString | userStylePath () |
Returns the path to user's style. More... | |
static QString | userThemesFolder () |
Returns the path to user's themes folder. More... | |
static QgsValidityCheckRegistry * | validityCheckRegistry () |
Returns the application's validity check registry, used for managing validity checks. More... | |
Static Public Attributes | |
static const char * | QGIS_APPLICATION_NAME = "QGIS3" |
static const char * | QGIS_ORGANIZATION_DOMAIN = "qgis.org" |
static const char * | QGIS_ORGANIZATION_NAME = "QGIS" |
static const QgsSettingsEntryString | settingsLocaleGlobalLocale = QgsSettingsEntryString( QStringLiteral( "locale/globalLocale" ), QgsSettings::NoSection, QString() ) |
Settings entry locale global locale. More... | |
static const QgsSettingsEntryBool | settingsLocaleOverrideFlag = QgsSettingsEntryBool( QStringLiteral( "locale/overrideFlag" ), QgsSettings::NoSection, false ) |
Settings entry locale override flag. More... | |
static const QgsSettingsEntryBool | settingsLocaleShowGroupSeparator = QgsSettingsEntryBool( QStringLiteral( "locale/showGroupSeparator" ), QgsSettings::NoSection, false ) |
Settings entry locale show group separator. More... | |
static const QgsSettingsEntryString | settingsLocaleUserLocale = QgsSettingsEntryString( QStringLiteral( "locale/userLocale" ), QgsSettings::NoSection, QString() ) |
Settings entry locale user locale. More... | |
static const QgsSettingsEntryStringList | settingsSearchPathsForSVG = QgsSettingsEntryStringList( QStringLiteral( "svg/searchPathsForSVG" ), QgsSettings::NoSection, QStringList() ) |
Settings entry search path for SVG. More... | |
Friends | |
class | TestQgsApplication |
Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc.
This is a subclass of QApplication and should be instantiated in place of QApplication. Most methods are static in keeping with 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 90 of file qgsapplication.h.
The Cursor enum defines constants for QGIS custom cursors.
Definition at line 398 of file qgsapplication.h.
The StyleSheetType enum represents the stylesheet type that a widget supports.
Is is used by widgets that display HTML content to retrieve the standard QGIS stylesheet, maintained according to QGIS visual guidelines.
Enumerator | |
---|---|
Qt | |
WebBrowser | StyleSheet for Qt GUI widgets (based on QLabel or QTextBrowser), supports basic CSS and Qt extensions. |
Definition at line 153 of file qgsapplication.h.
QgsApplication::QgsApplication | ( | int & | argc, |
char ** | argv, | ||
bool | GUIenabled, | ||
const QString & | profileFolder = QString() , |
||
const QString & | platformName = "external" |
||
) |
Constructor for QgsApplication.
argc | command line argument count |
argv | command line arguments |
GUIenabled | set to true if a GUI application is required, or false for a console only application |
profileFolder | optional string representing the profile to load at startup |
platformName | the QGIS platform name, e.g., "desktop", "server", "qgis_process" or "external" (for external CLI scripts) |
Definition at line 182 of file qgsapplication.cpp.
|
override |
Definition at line 443 of file qgsapplication.cpp.
|
static |
Converts absolute path to path relative to target.
Definition at line 1629 of file qgsapplication.cpp.
|
static |
Returns the action scope registry.
Definition at line 1995 of file qgsapplication.cpp.
|
static |
Returns the path to the currently active theme directory.
Definition at line 646 of file qgsapplication.cpp.
|
static |
Returns the application's annotation item registry, used for annotation item types.
Definition at line 2353 of file qgsapplication.cpp.
|
static |
Returns the application's annotation registry, used for managing annotation types.
Definition at line 2418 of file qgsapplication.cpp.
|
static |
Gets application icon.
Definition at line 661 of file qgsapplication.cpp.
|
static |
Apply the skipped drivers list to gdal.
Definition at line 1840 of file qgsapplication.cpp.
|
static |
Returns the application's authentication manager instance.
nullptr
if called before initQgis Definition at line 1389 of file qgsapplication.cpp.
|
static |
Returns the path to the authors file.
Definition at line 1036 of file qgsapplication.cpp.
|
static |
Returns the application's bookmark manager, used for storing installation-wide bookmarks.
Definition at line 2378 of file qgsapplication.cpp.
|
static |
Returns path to the build output directory. Valid only when running from build directory.
Definition at line 1759 of file qgsapplication.cpp.
|
static |
Returns path to the source directory. Valid only when running from build directory.
Definition at line 1754 of file qgsapplication.cpp.
|
static |
Returns the application's callout registry, used for managing callout types.
Definition at line 2343 of file qgsapplication.cpp.
|
static |
Returns the application's classification methods registry, used in graduated renderer.
Definition at line 2373 of file qgsapplication.cpp.
void QgsApplication::collectTranslatableObjects | ( | QgsTranslationContext * | translationContext | ) |
Emits the signal to collect all the strings of .qgs to be included in ts file.
Definition at line 1966 of file qgsapplication.cpp.
|
static |
Returns the application's color scheme registry, used for managing color schemes.
Definition at line 2263 of file qgsapplication.cpp.
|
static |
Returns the application's connection registry, used for managing saved data provider connections.
Definition at line 2408 of file qgsapplication.cpp.
|
static |
Returns the path to the contributors file.
Contributors are people who have submitted patches but don't have commit access.
Definition at line 1041 of file qgsapplication.cpp.
|
static |
Returns the application's coordinate reference system (CRS) registry, which handles known CRS definitions (including user-defined CRSes).
Definition at line 2308 of file qgsapplication.cpp.
|
static |
initialize qgis.db
Definition at line 2000 of file qgsapplication.cpp.
|
static |
Create the users theme folder.
Definition at line 1856 of file qgsapplication.cpp.
|
static |
Custom expression variables for this application.
This does not include generated variables (like system name, user name etc.)
Definition at line 1889 of file qgsapplication.cpp.
|
signal |
Emitted whenever a custom global variable changes.
|
static |
Returns the application's data item provider registry, which keeps a list of data item providers that may add items to the browser tree.
Definition at line 2288 of file qgsapplication.cpp.
|
static |
Returns a shared QgsStyleModel containing the default style library (see QgsStyle::defaultStyle()).
Using this shared model instead of creating a new QgsStyleModel improves performance.
Definition at line 2393 of file qgsapplication.cpp.
|
static |
Returns the path to default style (works as a starting point).
Definition at line 1327 of file qgsapplication.cpp.
|
static |
Returns the path to the default theme directory.
Definition at line 642 of file qgsapplication.cpp.
|
static |
Returns the path to default themes folder from install (works as a starting point).
Definition at line 1332 of file qgsapplication.cpp.
|
static |
Returns the list of gdal drivers that have been disabled in the current session, and thus, for safety, should not be disabled right now, but at the next application restart.
Definition at line 1835 of file qgsapplication.cpp.
|
static |
Returns the path to the developers map file.
The developers map was created by using leaflet framework, it shows the contributors.json file.
Definition at line 1045 of file qgsapplication.cpp.
|
static |
Returns the path to the donors file.
Definition at line 1055 of file qgsapplication.cpp.
|
static |
Returns whether this machine uses big or little endian.
Definition at line 1357 of file qgsapplication.cpp.
|
override |
Watch for QFileOpenEvent.
Definition at line 472 of file qgsapplication.cpp.
|
static |
deletes provider registry and map layer registry
Definition at line 1409 of file qgsapplication.cpp.
|
static |
Returns registry of available external storage implementations.
Definition at line 2453 of file qgsapplication.cpp.
|
static |
Gets the registry of available field formatters.
Definition at line 2428 of file qgsapplication.cpp.
|
static |
Helper to get a theme cursor.
It will fall back to the default theme if the active theme does not have the required icon. Cursors are automatically scaled to look like a 16px cursor on 96dpi screens.
Definition at line 751 of file qgsapplication.cpp.
|
static |
Helper to get a theme icon.
It will fall back to the default theme if the active theme does not have the required icon.
Since QGIS 3.20, the optional fillColor and strokeColor arguments can be used to control the color of parameter based SVG icons.
Definition at line 682 of file qgsapplication.cpp.
|
static |
Helper to get a theme icon as a pixmap.
It will fall back to the default theme if the active theme does not have the required icon.
If foreColor or backColor are specified, then these colors will be used for parametrized colors in SVG files wherever available. If colors are specified then the size argument also must be set.
Definition at line 816 of file qgsapplication.cpp.
|
static |
Returns the application's GPSBabel format registry, used for managing GPSBabel formats.
Definition at line 2363 of file qgsapplication.cpp.
|
static |
Returns the application's GPS connection registry, used for managing GPS connections.
Definition at line 2358 of file qgsapplication.cpp.
|
static |
Returns the path to the translation directory.
Definition at line 1070 of file qgsapplication.cpp.
|
static |
Returns path to the desired icon file.
First it tries to use the active theme path, then default theme path
Definition at line 671 of file qgsapplication.cpp.
|
static |
Returns the path to the icons image directory.
Definition at line 1108 of file qgsapplication.cpp.
|
static |
Returns the application's image cache, used for caching resampled versions of raster images.
Definition at line 2318 of file qgsapplication.cpp.
|
static |
This method initializes paths etc for QGIS.
Called by the ctor or call it manually when your app does not extend the QApplication class.
Definition at line 238 of file qgsapplication.cpp.
|
static |
loads providers
Definition at line 1362 of file qgsapplication.cpp.
|
static |
Returns the singleton instance of the QgsApplication.
Definition at line 467 of file qgsapplication.cpp.
|
inlinestatic |
Indicates whether running from build directory (not installed)
Definition at line 579 of file qgsapplication.h.
|
static |
Returns the application's layout item registry, used for layout item types.
Definition at line 2348 of file qgsapplication.cpp.
|
static |
Returns the paths to layout template directories.
Definition at line 1177 of file qgsapplication.cpp.
|
static |
Returns the path with utility executables (help viewer, crssync, ...)
Definition at line 1347 of file qgsapplication.cpp.
|
static |
Returns the path containing qgis_core, qgis_gui, qgispython (and other) libraries.
Definition at line 1342 of file qgsapplication.cpp.
|
static |
Returns the path to the licence file.
Definition at line 1065 of file qgsapplication.cpp.
|
static |
|
signal |
Emitted when project locale has been changed.
|
static |
Returns the registry of data repositories These are used as paths for basemaps, logos, etc.
which can be referenced differently across work stations.
Definition at line 2458 of file qgsapplication.cpp.
int QgsApplication::maxConcurrentConnectionsPerPool | ( | ) | const |
The maximum number of concurrent connections per connections pool.
Definition at line 1951 of file qgsapplication.cpp.
|
static |
Gets maximum concurrent thread count.
Definition at line 666 of file qgsapplication.cpp.
|
static |
Returns the application's message log.
Definition at line 2398 of file qgsapplication.cpp.
|
static |
Returns the path to the metadata directory.
Definition at line 1078 of file qgsapplication.cpp.
|
static |
Returns the application's network content registry used for fetching temporary files during QGIS session.
Definition at line 2328 of file qgsapplication.cpp.
|
override |
Catch exceptions when sending event to receiver.
Definition at line 500 of file qgsapplication.cpp.
|
static |
This string is used to represent the value NULL
throughout QGIS.
In general, when passing values around, prefer to use a null QVariant QVariant( field.type() )
or QVariant( QVariant::Int )
. This value should only be used in the final presentation step when showing values in a widget or sending it to a web browser.
Definition at line 1971 of file qgsapplication.cpp.
|
signal |
This string is used to represent the value NULL
throughout QGIS.
In general, when passing values around, prefer to use a null QVariant QVariant( field.type() )
or QVariant( QVariant::Int )
. This value should only be used in the final presentation step when showing values in a widget or sending it to a web browser.
|
static |
Gets the registry of available numeric formats.
Definition at line 2423 of file qgsapplication.cpp.
|
static |
Returns a string name of the operating system QGIS is running on.
Definition at line 1269 of file qgsapplication.cpp.
|
static |
Returns the application's page size registry, used for managing layout page sizes.
Definition at line 2413 of file qgsapplication.cpp.
|
static |
Returns the application's paint effect registry, used for managing paint effects.
Definition at line 2268 of file qgsapplication.cpp.
|
static |
Returns the common root path of all application data directories.
Definition at line 634 of file qgsapplication.cpp.
|
static |
Returns the QGIS platform name, e.g., "desktop", "server", "qgis_process" or "external" (for external CLI scripts).
Definition at line 1292 of file qgsapplication.cpp.
|
static |
Returns the application's plugin layer registry, used for managing plugin layer types.
Definition at line 2368 of file qgsapplication.cpp.
|
static |
Returns the path to the application plugin directory.
Definition at line 629 of file qgsapplication.cpp.
|
static |
Returns the application's point cloud renderer registry, used for managing point cloud layer 2D renderers.
Definition at line 2283 of file qgsapplication.cpp.
|
static |
Returns the path to the application prefix directory.
Definition at line 611 of file qgsapplication.cpp.
|
signal |
|
static |
Returns the application's processing registry, used for managing processing providers, algorithms, and various parameters and outputs.
Definition at line 2403 of file qgsapplication.cpp.
|
static |
Returns the application runtime profiler.
Definition at line 538 of file qgsapplication.cpp.
|
static |
Returns registry of available project storage implementations.
Definition at line 2448 of file qgsapplication.cpp.
|
static |
Returns the path to the user authentication database file: qgis-auth.db.
Definition at line 1098 of file qgsapplication.cpp.
|
static |
Returns the path to the master qgis.db file.
Definition at line 1083 of file qgsapplication.cpp.
|
static |
Returns the path to the settings directory in user's home dir.
Definition at line 1088 of file qgsapplication.cpp.
|
static |
Returns the path to the user qgis.db file.
Definition at line 1093 of file qgsapplication.cpp.
|
static |
Returns the path where QML components are installed for QGIS Quick library.
Returns empty string when QGIS is built without Quick support
Definition at line 1352 of file qgsapplication.cpp.
|
static |
Returns the application's raster renderer registry, used for managing raster layer renderers.
Definition at line 2278 of file qgsapplication.cpp.
|
static |
Returns the handler for recently used style items.
Definition at line 2388 of file qgsapplication.cpp.
|
static |
Register gdal drivers, excluding the ones mentioned in "gdal/skipList" setting.
Definition at line 1812 of file qgsapplication.cpp.
|
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 1621 of file qgsapplication.cpp.
|
static |
Converts path relative to target to an absolute path.
Definition at line 1699 of file qgsapplication.cpp.
|
static |
Returns registry of available 3D renderers.
Definition at line 2433 of file qgsapplication.cpp.
|
static |
Returns the application's renderer registry, used for managing vector layer renderers.
Definition at line 2273 of file qgsapplication.cpp.
|
static |
Returns a css style sheet for reports, the styleSheetType argument determines what type of stylesheet is supported by the widget.
Typically you will use this method by doing: QString myStyle = QgsApplication::reportStyleSheet(); textBrowserReport->document()->setDefaultStyleSheet(myStyle); if you are using a QgsWebView you will need to manually inject the CSS into a head -> script tag instead.
Definition at line 1470 of file qgsapplication.cpp.
|
signal |
Emitted when project strings which require translation are being collected for inclusion in a .ts file.
In order to register translatable strings, connect to this signal and register the strings within the specified translationContext.
|
static |
Calculate the application pkg path.
Definition at line 836 of file qgsapplication.cpp.
|
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.
Definition at line 1781 of file qgsapplication.cpp.
|
static |
Gets the registry of available scalebar renderers.
Definition at line 2443 of file qgsapplication.cpp.
|
static |
Scales an icon size to compensate for display pixel density, making the icon size hi-dpi friendly, whilst still resulting in pixel-perfect sizes for low-dpi displays.
standardSize should be set to a standard icon size, e.g. 16, 24, 48, etc.
Definition at line 1933 of file qgsapplication.cpp.
|
static |
Returns the path to the server resources directory.
Definition at line 1337 of file qgsapplication.cpp.
|
static |
Alters authentication data base directory path - used by 3rd party apps.
Definition at line 602 of file qgsapplication.cpp.
|
static |
Set a single custom expression variable.
Definition at line 1923 of file qgsapplication.cpp.
|
static |
Custom expression variables for this application.
Do not include generated variables (like system name, user name etc.)
Definition at line 1908 of file qgsapplication.cpp.
|
static |
Alters default svg paths - used by 3rd party apps.
Definition at line 597 of file qgsapplication.cpp.
|
static |
Sets the FileOpen event receiver.
Definition at line 543 of file qgsapplication.cpp.
|
static |
Sets the QGIS locale - used mainly by 3rd party apps and tests.
In QGIS this is internally triggered by the application in startup.
Definition at line 1316 of file qgsapplication.cpp.
|
static |
Set maximum concurrent thread count.
Definition at line 2232 of file qgsapplication.cpp.
|
static |
This string is used to represent the value NULL
throughout QGIS.
In general, when passing values around, prefer to use a null QVariant QVariant( field.type() )
or QVariant( QVariant::Int )
. This value should only be used in the final presentation step when showing values in a widget or sending it to a web browser.
Definition at line 1981 of file qgsapplication.cpp.
|
static |
Alters pkg data path - used by 3rd party apps.
Definition at line 586 of file qgsapplication.cpp.
|
static |
Alters plugin path - used by 3rd party apps.
Definition at line 581 of file qgsapplication.cpp.
|
static |
Alters prefix path - used by 3rd party apps.
Definition at line 560 of file qgsapplication.cpp.
|
static |
Sets the list of gdal drivers that should be disabled (skippedGdalDrivers), but excludes for now the ones defines in deferredSkippedGdalDrivers.
This writes the "gdal/skipList" setting.
Definition at line 1800 of file qgsapplication.cpp.
|
static |
Sets the paths to svg directories and invalidates the svg path list cache.
Definition at line 1136 of file qgsapplication.cpp.
|
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.
Definition at line 831 of file qgsapplication.cpp.
|
static |
Returns the application's settings registry, used for managing application settings.
Definition at line 2258 of file qgsapplication.cpp.
|
static |
|
static |
Set the current UI theme used to style the interface.
Use uiThemes() to find valid themes to use. Variables found in variables.qss will be added to the stylesheet on load.
themeName | The name of the theme. |
Definition at line 922 of file qgsapplication.cpp.
|
static |
Returns the short name regular expression for line edit validator.
shortNameRegExp
for QGIS <= 3.20 Definition at line 1194 of file qgsapplication.cpp.
|
static |
Convenience function to get a summary of the paths used in this application instance useful for debugging mainly.
Definition at line 1443 of file qgsapplication.cpp.
|
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.
Definition at line 1771 of file qgsapplication.cpp.
|
static |
Returns the list of gdal drivers that should be skipped (based on GDAL_SKIP environment variable)
Definition at line 1795 of file qgsapplication.cpp.
|
static |
Returns the application's source cache, used for caching embedded and remote source strings as local files.
Definition at line 2323 of file qgsapplication.cpp.
|
static |
Returns the path to the splash screen image directory.
Definition at line 1103 of file qgsapplication.cpp.
|
static |
Returns the path to the sponsors file.
Definition at line 1050 of file qgsapplication.cpp.
|
static |
Returns the path to the srs.db file.
Definition at line 1113 of file qgsapplication.cpp.
|
static |
Returns the application's SVG cache, used for caching SVG images and handling parameter replacement within SVG files.
Definition at line 2313 of file qgsapplication.cpp.
|
static |
Returns the paths to svg directories.
Definition at line 1142 of file qgsapplication.cpp.
|
static |
Returns registry of available 3D symbols.
Definition at line 2438 of file qgsapplication.cpp.
|
static |
Returns the application's symbol layer registry, used for managing symbol layers.
Definition at line 2338 of file qgsapplication.cpp.
|
static |
Returns the system environment variables passed to application.
Definition at line 1184 of file qgsapplication.cpp.
|
static |
Returns the application's task manager, used for managing application wide background task handling.
Definition at line 2253 of file qgsapplication.cpp.
|
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.
Definition at line 917 of file qgsapplication.cpp.
|
static |
Returns the application's tile download manager, used for download of map tiles when rendering.
Definition at line 2383 of file qgsapplication.cpp.
QString QgsApplication::translation | ( | ) | const |
Returns the current application translation locale code.
Definition at line 1961 of file qgsapplication.cpp.
|
static |
Returns the path to the sponsors file.
Definition at line 1060 of file qgsapplication.cpp.
|
static |
All themes found in ~/.qgis3/themes folder.
The path is to the root folder for the theme
Definition at line 1011 of file qgsapplication.cpp.
|
static |
Returns the user's operating system login account full display name.
Definition at line 1235 of file qgsapplication.cpp.
|
static |
Returns the user's operating system login account name.
Definition at line 1200 of file qgsapplication.cpp.
|
static |
Returns the path to user's style.
Definition at line 1189 of file qgsapplication.cpp.
|
static |
Returns the path to user's themes folder.
Definition at line 1322 of file qgsapplication.cpp.
|
static |
Returns the application's validity check registry, used for managing validity checks.
Definition at line 2333 of file qgsapplication.cpp.
|
friend |
Definition at line 1149 of file qgsapplication.h.
|
static |
Definition at line 161 of file qgsapplication.h.
|
static |
Definition at line 160 of file qgsapplication.h.
|
static |
Definition at line 159 of file qgsapplication.h.
|
inlinestatic |
Settings entry locale global locale.
Definition at line 1016 of file qgsapplication.h.
|
inlinestatic |
Settings entry locale override flag.
Definition at line 1014 of file qgsapplication.h.
|
inlinestatic |
Settings entry locale show group separator.
Definition at line 1018 of file qgsapplication.h.
|
inlinestatic |
Settings entry locale user locale.
Definition at line 1012 of file qgsapplication.h.
|
inlinestatic |
Settings entry search path for SVG.
Definition at line 1020 of file qgsapplication.h.