QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Classes | Public Types | Signals | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
QgsApplication Class Reference

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

#include <qgsapplication.h>

Inheritance diagram for QgsApplication:
Inheritance graph
[legend]

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...
 

Signals

void customVariablesChanged ()
 Emitted whenever a custom global variable changes. 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="desktop")
 
 ~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...
 

Static Public Member Functions

static QString absolutePathToRelativePath (const QString &apath, const QString &targetPath)
 Converts absolute path to path relative to target. More...
 
static QgsActionScopeRegistryactionScopeRegistry ()
 Returns the action scope registry. More...
 
static QString activeThemePath ()
 Returns the path to the currently active theme directory. 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 QgsAuthManagerauthManager ()
 Returns the application's authentication manager instance. More...
 
static QString authorsFilePath ()
 Returns the path to the authors file. 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 QgsColorSchemeRegistrycolorSchemeRegistry ()
 Returns the application's color scheme registry, used for managing color schemes. More...
 
static QString contributorsFilePath ()
 Returns the path to the contributors file. 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 QgsDataItemProviderRegistrydataItemProviderRegistry ()
 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 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 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...
 
template<typename T >
static void endian_swap (T &value)
 Swap the endianness of the specified value. More...
 
static void exitQgis ()
 deletes provider registry and map layer registry More...
 
static QgsFieldFormatterRegistryfieldFormatterRegistry ()
 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)
 Helper to get a theme icon. More...
 
static QPixmap getThemePixmap (const QString &name)
 Helper to get a theme icon as a pixmap. More...
 
static QgsGpsConnectionRegistrygpsConnectionRegistry ()
 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 void init (QString profileFolder=QString())
 This method initializes paths etc for QGIS. More...
 
static void initQgis ()
 loads providers More...
 
static QgsApplicationinstance ()
 Returns the singleton instance of the QgsApplication. More...
 
static bool isRunningFromBuildDir ()
 Indicates whether running from build directory (not installed) More...
 
static QgsLayoutItemRegistrylayoutItemRegistry ()
 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 int maxThreads ()
 Gets maximum concurrent thread count. More...
 
static QgsMessageLogmessageLog ()
 Returns the application's message log. More...
 
static QString metadataPath ()
 Returns the path to the metadata directory. More...
 
static QgsNetworkContentFetcherRegistrynetworkContentFetcherRegistry ()
 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 QString osName ()
 Returns a string name of the operating system QGIS is running on. More...
 
static QgsPageSizeRegistrypageSizeRegistry ()
 Returns the application's page size registry, used for managing layout page sizes. More...
 
static QgsPaintEffectRegistrypaintEffectRegistry ()
 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" or "server". More...
 
static QgsPluginLayerRegistrypluginLayerRegistry ()
 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 QString prefixPath ()
 Returns the path to the application prefix directory. More...
 
static QgsProcessingRegistryprocessingRegistry ()
 Returns the application's processing registry, used for managing processing providers, algorithms, and various parameters and outputs. More...
 
static QgsRuntimeProfilerprofiler ()
 Returns the application runtime profiler. More...
 
static QgsProjectStorageRegistryprojectStorageRegistry ()
 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 QgsRasterRendererRegistryrasterRendererRegistry ()
 Returns the application's raster renderer registry, used for managing raster layer renderers. 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 Qgs3DRendererRegistryrenderer3DRegistry ()
 Returns registry of available 3D renderers. More...
 
static QgsRendererRegistryrendererRegistry ()
 Returns the application's renderer registry, used for managing vector layer renderers. More...
 
static QString reportStyleSheet ()
 Returns a standard css style sheet for reports. 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 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 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 setThemeName (const QString &themeName)
 Set the active theme to the specified theme. More...
 
static void setTranslation (const QString &translation)
 Set translation. More...
 
static void setUITheme (const QString &themeName)
 Set the current UI theme used to style the interface. More...
 
static QRegExp shortNameRegExp ()
 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 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 QgsSvgCachesvgCache ()
 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 QgsSymbolLayerRegistrysymbolLayerRegistry ()
 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 QgsTaskManagertaskManager ()
 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 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 Public Attributes

static const char * QGIS_APPLICATION_NAME = "QGIS3"
 
static const char * QGIS_ORGANIZATION_DOMAIN = "qgis.org"
 
static const char * QGIS_ORGANIZATION_NAME = "QGIS"
 

Detailed Description

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 68 of file qgsapplication.h.

Member Enumeration Documentation

The Cursor enum defines constants for QGIS custom cursors.

Enumerator
ZoomIn 

Zoom in.

ZoomOut 

Zoom out.

Identify 

Identify: obtain information about the object.

CrossHair 

Precisely identify a point on the canvas.

CapturePoint 

Select and capture a point or a feature.

Select 

Select a rectangle.

Sampler 

Color/Value picker.

Definition at line 331 of file qgsapplication.h.

Constants for endian-ness.

Enumerator
XDR 
NDR 

Definition at line 450 of file qgsapplication.h.

Constructor & Destructor Documentation

QgsApplication::QgsApplication ( int &  argc,
char **  argv,
bool  GUIenabled,
const QString &  profileFolder = QString(),
const QString &  platformName = "desktop" 
)

Definition at line 131 of file qgsapplication.cpp.

QgsApplication::~QgsApplication ( )
override

Definition at line 303 of file qgsapplication.cpp.

Member Function Documentation

QString QgsApplication::absolutePathToRelativePath ( const QString &  apath,
const QString &  targetPath 
)
static

Converts absolute path to path relative to target.

Definition at line 1356 of file qgsapplication.cpp.

QgsActionScopeRegistry * QgsApplication::actionScopeRegistry ( )
static

Returns the action scope registry.

Since
QGIS 3.0

Definition at line 1614 of file qgsapplication.cpp.

QString QgsApplication::activeThemePath ( )
static

Returns the path to the currently active theme directory.

Definition at line 499 of file qgsapplication.cpp.

QgsAnnotationRegistry * QgsApplication::annotationRegistry ( )
static

Returns the application's annotation registry, used for managing annotation types.

Note
not available in Python bindings
Since
QGIS 3.0

Definition at line 1920 of file qgsapplication.cpp.

QString QgsApplication::appIconPath ( )
static

Gets application icon.

Definition at line 514 of file qgsapplication.cpp.

void QgsApplication::applyGdalSkippedDrivers ( )
static

Apply the skipped drivers list to gdal.

See also
skipGdalDriver
restoreGdalDriver
skippedGdalDrivers

Definition at line 1495 of file qgsapplication.cpp.

QgsAuthManager * QgsApplication::authManager ( )
static

Returns the application's authentication manager instance.

Note
this can be a null pointer if called before initQgis
See also
initQgis
Since
QGIS 3.0

Definition at line 1172 of file qgsapplication.cpp.

QString QgsApplication::authorsFilePath ( )
static

Returns the path to the authors file.

Definition at line 843 of file qgsapplication.cpp.

static QString QgsApplication::buildOutputPath ( )
inlinestatic

Returns path to the build output directory. Valid only when running from build directory.

Definition at line 516 of file qgsapplication.h.

static QString QgsApplication::buildSourcePath ( )
inlinestatic

Returns path to the source directory. Valid only when running from build directory.

Definition at line 514 of file qgsapplication.h.

void QgsApplication::collectTranslatableObjects ( QgsTranslationContext translationContext)

Emits the signal to collect all the strings of .qgs to be included in ts file.

Since
QGIS 3.4

Definition at line 1585 of file qgsapplication.cpp.

QgsColorSchemeRegistry * QgsApplication::colorSchemeRegistry ( )
static

Returns the application's color scheme registry, used for managing color schemes.

Since
QGIS 3.0

Definition at line 1835 of file qgsapplication.cpp.

QString QgsApplication::contributorsFilePath ( )
static

Returns the path to the contributors file.

Contributors are people who have submitted patches but don't have commit access.

Definition at line 848 of file qgsapplication.cpp.

bool QgsApplication::createDatabase ( QString *  errorMessage = nullptr)
static

initialize qgis.db

Definition at line 1619 of file qgsapplication.cpp.

bool QgsApplication::createThemeFolder ( )
static

Create the users theme folder.

Definition at line 1505 of file qgsapplication.cpp.

QVariantMap QgsApplication::customVariables ( )
static

Custom expression variables for this application.

This does not include generated variables (like system name, user name etc.)

See also
QgsExpressionContextUtils::globalScope().
Since
QGIS 3.0

Definition at line 1536 of file qgsapplication.cpp.

void QgsApplication::customVariablesChanged ( )
signal

Emitted whenever a custom global variable changes.

Since
QGIS 3.0
QgsDataItemProviderRegistry * QgsApplication::dataItemProviderRegistry ( )
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.

Since
QGIS 3.0

Definition at line 1855 of file qgsapplication.cpp.

QString QgsApplication::defaultStylePath ( )
static

Returns the path to default style (works as a starting point).

Definition at line 1109 of file qgsapplication.cpp.

QString QgsApplication::defaultThemePath ( )
static

Returns the path to the default theme directory.

Definition at line 495 of file qgsapplication.cpp.

QString QgsApplication::defaultThemesFolder ( )
static

Returns the path to default themes folder from install (works as a starting point).

Definition at line 1114 of file qgsapplication.cpp.

QString QgsApplication::developersMapFilePath ( )
static

Returns the path to the developers map file.

The developers map was created by using leaflet framework, it shows the contributors.json file.

Since
QGIS 2.7

Definition at line 852 of file qgsapplication.cpp.

QString QgsApplication::donorsFilePath ( )
static

Returns the path to the donors file.

Definition at line 862 of file qgsapplication.cpp.

QgsApplication::endian_t QgsApplication::endian ( )
static

Returns whether this machine uses big or little endian.

Definition at line 1139 of file qgsapplication.cpp.

template<typename T >
static void QgsApplication::endian_swap ( T &  value)
inlinestatic

Swap the endianness of the specified value.

Note
not available in Python bindings

Definition at line 465 of file qgsapplication.h.

bool QgsApplication::event ( QEvent *  event)
override

Watch for QFileOpenEvent.

Definition at line 331 of file qgsapplication.cpp.

void QgsApplication::exitQgis ( )
static

deletes provider registry and map layer registry

Definition at line 1192 of file qgsapplication.cpp.

QgsFieldFormatterRegistry * QgsApplication::fieldFormatterRegistry ( )
static

Gets the registry of available field formatters.

Definition at line 1925 of file qgsapplication.cpp.

QCursor QgsApplication::getThemeCursor ( Cursor  cursor)
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 560 of file qgsapplication.cpp.

QIcon QgsApplication::getThemeIcon ( const QString &  name)
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.

Definition at line 530 of file qgsapplication.cpp.

QPixmap QgsApplication::getThemePixmap ( const QString &  name)
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.

Definition at line 625 of file qgsapplication.cpp.

QgsGpsConnectionRegistry * QgsApplication::gpsConnectionRegistry ( )
static

Returns the application's GPS connection registry, used for managing GPS connections.

Since
QGIS 3.0

Definition at line 1895 of file qgsapplication.cpp.

QString QgsApplication::i18nPath ( )
static

Returns the path to the translation directory.

Definition at line 877 of file qgsapplication.cpp.

QString QgsApplication::iconPath ( const 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 519 of file qgsapplication.cpp.

QString QgsApplication::iconsPath ( )
static

Returns the path to the icons image directory.

Definition at line 915 of file qgsapplication.cpp.

void QgsApplication::init ( QString  profileFolder = QString())
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.

Note
you will probably want to call initQgis too to load the providers in the above case.
not available in Python bindings

Definition at line 169 of file qgsapplication.cpp.

void QgsApplication::initQgis ( )
static

loads providers

Definition at line 1144 of file qgsapplication.cpp.

QgsApplication * QgsApplication::instance ( )
static

Returns the singleton instance of the QgsApplication.

Since
QGIS 3.0

Definition at line 326 of file qgsapplication.cpp.

static bool QgsApplication::isRunningFromBuildDir ( )
inlinestatic

Indicates whether running from build directory (not installed)

Definition at line 509 of file qgsapplication.h.

QgsLayoutItemRegistry * QgsApplication::layoutItemRegistry ( )
static

Returns the application's layout item registry, used for layout item types.

Since
QGIS 3.0

Definition at line 1890 of file qgsapplication.cpp.

QStringList QgsApplication::layoutTemplatePaths ( )
static

Returns the paths to layout template directories.

Since
QGIS 3.0

Definition at line 966 of file qgsapplication.cpp.

QString QgsApplication::libexecPath ( )
static

Returns the path with utility executables (help viewer, crssync, ...)

Definition at line 1129 of file qgsapplication.cpp.

QString QgsApplication::libraryPath ( )
static

Returns the path containing qgis_core, qgis_gui, qgispython (and other) libraries.

Definition at line 1124 of file qgsapplication.cpp.

QString QgsApplication::licenceFilePath ( )
static

Returns the path to the licence file.

Definition at line 872 of file qgsapplication.cpp.

QString QgsApplication::locale ( )
static

Returns the QGIS locale.

Since
QGIS 3.0

Definition at line 1083 of file qgsapplication.cpp.

int QgsApplication::maxConcurrentConnectionsPerPool ( ) const

The maximum number of concurrent connections per connections pool.

Note
QGIS may in some situations allocate more than this amount of connections to avoid deadlocks.
Since
QGIS 3.4

Definition at line 1580 of file qgsapplication.cpp.

static int QgsApplication::maxThreads ( )
inlinestatic

Gets maximum concurrent thread count.

Since
QGIS 2.4

Definition at line 548 of file qgsapplication.h.

QgsMessageLog * QgsApplication::messageLog ( )
static

Returns the application's message log.

Since
QGIS 3.0

Definition at line 1905 of file qgsapplication.cpp.

QString QgsApplication::metadataPath ( )
static

Returns the path to the metadata directory.

Since
QGIS 3.0

Definition at line 885 of file qgsapplication.cpp.

QgsNetworkContentFetcherRegistry * QgsApplication::networkContentFetcherRegistry ( )
static

Returns the application's network content registry used for fetching temporary files during QGIS session.

Since
QGIS 3.2

Definition at line 1880 of file qgsapplication.cpp.

bool QgsApplication::notify ( QObject *  receiver,
QEvent *  event 
)
override

Catch exceptions when sending event to receiver.

Definition at line 359 of file qgsapplication.cpp.

QString QgsApplication::nullRepresentation ( )
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 1590 of file qgsapplication.cpp.

void QgsApplication::nullRepresentationChanged ( )
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.

QString QgsApplication::osName ( )
static

Returns a string name of the operating system QGIS is running on.

See also
platform()
Since
QGIS 2.14

Definition at line 1055 of file qgsapplication.cpp.

QgsPageSizeRegistry * QgsApplication::pageSizeRegistry ( )
static

Returns the application's page size registry, used for managing layout page sizes.

Since
QGIS 3.0

Definition at line 1915 of file qgsapplication.cpp.

QgsPaintEffectRegistry * QgsApplication::paintEffectRegistry ( )
static

Returns the application's paint effect registry, used for managing paint effects.

Since
QGIS 3.0

Definition at line 1840 of file qgsapplication.cpp.

QString QgsApplication::pkgDataPath ( )
static

Returns the common root path of all application data directories.

Definition at line 488 of file qgsapplication.cpp.

QString QgsApplication::platform ( )
static

Returns the QGIS platform name, e.g., "desktop" or "server".

See also
osName()
Since
QGIS 2.14

Definition at line 1078 of file qgsapplication.cpp.

QgsPluginLayerRegistry * QgsApplication::pluginLayerRegistry ( )
static

Returns the application's plugin layer registry, used for managing plugin layer types.

Since
QGIS 3.0

Definition at line 1900 of file qgsapplication.cpp.

QString QgsApplication::pluginPath ( )
static

Returns the path to the application plugin directory.

Definition at line 484 of file qgsapplication.cpp.

QString QgsApplication::prefixPath ( )
static

Returns the path to the application prefix directory.

Definition at line 468 of file qgsapplication.cpp.

void QgsApplication::preNotify ( QObject *  receiver,
QEvent *  event,
bool *  done 
)
signal
Note
not available in Python bindings
QgsProcessingRegistry * QgsApplication::processingRegistry ( )
static

Returns the application's processing registry, used for managing processing providers, algorithms, and various parameters and outputs.

Since
QGIS 3.0

Definition at line 1910 of file qgsapplication.cpp.

QgsRuntimeProfiler * QgsApplication::profiler ( )
static

Returns the application runtime profiler.

Since
QGIS 3.0

Definition at line 397 of file qgsapplication.cpp.

QgsProjectStorageRegistry * QgsApplication::projectStorageRegistry ( )
static

Returns registry of available project storage implementations.

Since
QGIS 3.2

Definition at line 1935 of file qgsapplication.cpp.

QString QgsApplication::qgisAuthDatabaseFilePath ( )
static

Returns the path to the user authentication database file: qgis-auth.db.

Definition at line 905 of file qgsapplication.cpp.

QString QgsApplication::qgisMasterDatabaseFilePath ( )
static

Returns the path to the master qgis.db file.

Definition at line 890 of file qgsapplication.cpp.

QString QgsApplication::qgisSettingsDirPath ( )
static

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

Definition at line 895 of file qgsapplication.cpp.

QString QgsApplication::qgisUserDatabaseFilePath ( )
static

Returns the path to the user qgis.db file.

Definition at line 900 of file qgsapplication.cpp.

QString QgsApplication::qmlImportPath ( )
static

Returns the path where QML components are installed for QGIS Quick library.

Returns empty string when QGIS is built without Quick support

Since
QGIS 3.2

Definition at line 1134 of file qgsapplication.cpp.

QgsRasterRendererRegistry * QgsApplication::rasterRendererRegistry ( )
static

Returns the application's raster renderer registry, used for managing raster layer renderers.

Note
not available in Python bindings
Since
QGIS 3.0

Definition at line 1850 of file qgsapplication.cpp.

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 1348 of file qgsapplication.cpp.

QString QgsApplication::relativePathToAbsolutePath ( const QString &  rpath,
const QString &  targetPath 
)
static

Converts path relative to target to an absolute path.

Definition at line 1421 of file qgsapplication.cpp.

Qgs3DRendererRegistry * QgsApplication::renderer3DRegistry ( )
static

Returns registry of available 3D renderers.

Since
QGIS 3.0

Definition at line 1930 of file qgsapplication.cpp.

QgsRendererRegistry * QgsApplication::rendererRegistry ( )
static

Returns the application's renderer registry, used for managing vector layer renderers.

Since
QGIS 3.0

Definition at line 1845 of file qgsapplication.cpp.

QString QgsApplication::reportStyleSheet ( )
static

Returns a standard css style sheet for reports.

Typically you will use this method by doing: QString myStyle = QgsApplication::reportStyleSheet(); textBrowserReport->document()->setDefaultStyleSheet(myStyle);

Returns
QString containing the CSS 2.1 compliant stylesheet.
Note
you can use the special Qt extensions too, for example the gradient fills for backgrounds.

Definition at line 1248 of file qgsapplication.cpp.

void QgsApplication::requestForTranslatableObjects ( QgsTranslationContext translationContext)
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.

Since
QGIS 3.4
QString QgsApplication::resolvePkgPath ( )
static

Calculate the application pkg path.

Returns
the resolved pkg path

Definition at line 646 of file qgsapplication.cpp.

void QgsApplication::restoreGdalDriver ( const QString &  driver)
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 1481 of file qgsapplication.cpp.

QString QgsApplication::serverResourcesPath ( )
static

Returns the path to the server resources directory.

Definition at line 1119 of file qgsapplication.cpp.

void QgsApplication::setAuthDatabaseDirPath ( const QString &  authDbDirPath)
static

Alters authentication data base directory path - used by 3rd party apps.

Definition at line 459 of file qgsapplication.cpp.

void QgsApplication::setCustomVariable ( const QString &  name,
const QVariant &  value 
)
static

Set a single custom expression variable.

Since
QGIS 3.0

Definition at line 1570 of file qgsapplication.cpp.

void QgsApplication::setCustomVariables ( const QVariantMap &  customVariables)
static

Custom expression variables for this application.

Do not include generated variables (like system name, user name etc.)

See also
QgsExpressionContextUtils::globalScope().
Since
QGIS 3.0

Definition at line 1555 of file qgsapplication.cpp.

void QgsApplication::setDefaultSvgPaths ( const QStringList &  pathList)
static

Alters default svg paths - used by 3rd party apps.

Definition at line 454 of file qgsapplication.cpp.

void QgsApplication::setFileOpenEventReceiver ( QObject *  receiver)
static

Sets the FileOpen event receiver.

Definition at line 402 of file qgsapplication.cpp.

void QgsApplication::setMaxThreads ( int  maxThreads)
static

Set maximum concurrent thread count.

Note
must be between 1 and #cores, -1 means use all available cores
Since
QGIS 2.4

Definition at line 1809 of file qgsapplication.cpp.

void QgsApplication::setNullRepresentation ( const QString &  nullRepresentation)
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 1600 of file qgsapplication.cpp.

void QgsApplication::setPkgDataPath ( const QString &  pkgDataPath)
static

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

Definition at line 445 of file qgsapplication.cpp.

void QgsApplication::setPluginPath ( const QString &  pluginPath)
static

Alters plugin path - used by 3rd party apps.

Definition at line 440 of file qgsapplication.cpp.

void QgsApplication::setPrefixPath ( const QString &  prefixPath,
bool  useDefaultPaths = false 
)
static

Alters prefix path - used by 3rd party apps.

Definition at line 419 of file qgsapplication.cpp.

void QgsApplication::setThemeName ( const QString &  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 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'.

Definition at line 641 of file qgsapplication.cpp.

static void QgsApplication::setTranslation ( const QString &  translation)
inlinestatic

Set translation.

Since
QGIS 3.4

Definition at line 751 of file qgsapplication.h.

void QgsApplication::setUITheme ( const QString &  themeName)
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.

Parameters
themeNameThe name of the theme.
Note
using an invalid theme name will reset to default

Definition at line 731 of file qgsapplication.cpp.

QRegExp QgsApplication::shortNameRegExp ( )
static

Returns the short name regular expression for line edit validator.

Definition at line 981 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 1221 of file qgsapplication.cpp.

void QgsApplication::skipGdalDriver ( const QString &  driver)
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 1471 of file qgsapplication.cpp.

static QStringList QgsApplication::skippedGdalDrivers ( )
inlinestatic

Returns the list of gdal drivers that should be skipped (based on GDAL_SKIP environment variable)

Definition at line 536 of file qgsapplication.h.

QString QgsApplication::splashPath ( )
static

Returns the path to the splash screen image directory.

Definition at line 910 of file qgsapplication.cpp.

QString QgsApplication::sponsorsFilePath ( )
static

Returns the path to the sponsors file.

Definition at line 857 of file qgsapplication.cpp.

QString QgsApplication::srsDatabaseFilePath ( )
static

Returns the path to the srs.db file.

Definition at line 920 of file qgsapplication.cpp.

QgsSvgCache * QgsApplication::svgCache ( )
static

Returns the application's SVG cache, used for caching SVG images and handling parameter replacement within SVG files.

Since
QGIS 3.0

Definition at line 1875 of file qgsapplication.cpp.

QStringList QgsApplication::svgPaths ( )
static

Returns the paths to svg directories.

Definition at line 943 of file qgsapplication.cpp.

QgsSymbolLayerRegistry * QgsApplication::symbolLayerRegistry ( )
static

Returns the application's symbol layer registry, used for managing symbol layers.

Since
QGIS 3.0

Definition at line 1885 of file qgsapplication.cpp.

static QMap<QString, QString> QgsApplication::systemEnvVars ( )
inlinestatic

Returns the system environment variables passed to application.

Definition at line 298 of file qgsapplication.h.

QgsTaskManager * QgsApplication::taskManager ( )
static

Returns the application's task manager, used for managing application wide background task handling.

Since
QGIS 3.0

Definition at line 1830 of file qgsapplication.cpp.

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.

Definition at line 726 of file qgsapplication.cpp.

QString QgsApplication::translatorsFilePath ( )
static

Returns the path to the sponsors file.

Definition at line 867 of file qgsapplication.cpp.

QHash< QString, QString > QgsApplication::uiThemes ( )
static

All themes found in ~/.qgis3/themes folder.

The path is to the root folder for the theme

Returns
A hash of theme name and theme path. Valid theme folders contain style.qss
Note
Valid theme folders must contain a style.qss file.

Definition at line 820 of file qgsapplication.cpp.

QString QgsApplication::userFullName ( )
static

Returns the user's operating system login account full display name.

See also
userLoginName()
Since
QGIS 2.14

Definition at line 1021 of file qgsapplication.cpp.

QString QgsApplication::userLoginName ( )
static

Returns the user's operating system login account name.

See also
userFullName()
Since
QGIS 2.14

Definition at line 986 of file qgsapplication.cpp.

QString QgsApplication::userStylePath ( )
static

Returns the path to user's style.

Definition at line 976 of file qgsapplication.cpp.

QString QgsApplication::userThemesFolder ( )
static

Returns the path to user's themes folder.

Definition at line 1104 of file qgsapplication.cpp.

Member Data Documentation

const char * QgsApplication::QGIS_APPLICATION_NAME = "QGIS3"
static

Definition at line 125 of file qgsapplication.h.

const char * QgsApplication::QGIS_ORGANIZATION_DOMAIN = "qgis.org"
static

Definition at line 124 of file qgsapplication.h.

const char * QgsApplication::QGIS_ORGANIZATION_NAME = "QGIS"
static

Definition at line 123 of file qgsapplication.h.


The documentation for this class was generated from the following files: