QGIS API Documentation  2.11.0-Master
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  ENDIAN { XDR = 0, NDR = 1 }
 Constants for endian-ness. More...
 
typedef enum QgsApplication::ENDIAN endian_t
 Constants for endian-ness. More...
 

Signals

void preNotify (QObject *receiver, QEvent *event, bool *done)
 

Public Member Functions

 QgsApplication (int &argc, char **argv, bool GUIenabled, QString customConfigPath=QString())
 
virtual ~QgsApplication ()
 
virtual bool event (QEvent *event) override
 Watch for QFileOpenEvent. More...
 
virtual bool notify (QObject *receiver, QEvent *event) override
 Catch exceptions when sending event to receiver. More...
 
- Public Member Functions inherited from QApplication
 QApplication (int &argc, char **argv)
 
 QApplication (int &argc, char **argv, Type type)
 
 QApplication (Display *display, Qt::HANDLE visual, Qt::HANDLE colormap)
 
 QApplication (Display *display, int &argc, char **argv, Qt::HANDLE visual, Qt::HANDLE colormap)
 
 QApplication (QApplication::QS60MainApplicationFactory factory, int &argc, char **argv)
 
 QApplication (int &argc, char **argv, bool GUIenabled)
 
virtual  ~QApplication ()
 
void aboutToReleaseGpuResources ()
 
void aboutToUseGpuResources ()
 
int autoMaximizeThreshold () const
 
bool autoSipEnabled () const
 
virtual void commitData (QSessionManager &manager)
 
void commitDataRequest (QSessionManager &manager)
 
void focusChanged (QWidget *old, QWidget *now)
 
void fontDatabaseChanged ()
 
QInputContextinputContext () const
 
bool isSessionRestored () const
 
void lastWindowClosed ()
 
virtual bool macEventFilter (EventHandlerCallRef caller, EventRef event)
 
virtual bool qwsEventFilter (QWSEvent *event)
 
void qwsSetCustomColors (QRgb *colorTable, int start, int numColors)
 
virtual void saveState (QSessionManager &manager)
 
void saveStateRequest (QSessionManager &manager)
 
QString sessionId () const
 
QString sessionKey () const
 
void setAutoMaximizeThreshold (const int threshold)
 
void setAutoSipEnabled (const bool enabled)
 
void setInputContext (QInputContext *inputContext)
 
void setStyleSheet (const QString &sheet)
 
QString styleSheet () const
 
virtual bool symbianEventFilter (const QSymbianEvent *event)
 
int symbianProcessEvent (const QSymbianEvent *event)
 
virtual bool x11EventFilter (XEvent *event)
 
int x11ProcessEvent (XEvent *event)
 
- Public Member Functions inherited from QCoreApplication
 QCoreApplication (int &argc, char **argv)
 
 ~QCoreApplication ()
 
void aboutToQuit ()
 
bool filterEvent (void *message, long *result)
 
void lock ()
 
bool locked ()
 
EventFilter setEventFilter (EventFilter filter)
 
bool tryLock ()
 
void unlock (bool wakeUpGui)
 
virtual bool winEventFilter (MSG *msg, long *result)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Static Public Member Functions

static QString absolutePathToRelativePath (QString apath, QString targetPath)
 Converts absolute path to path relative to target. More...
 
static const QString activeThemePath ()
 Returns the path to the currently active theme directory. More...
 
static void applyGdalSkippedDrivers ()
 Apply the skipped drivers list to gdal. More...
 
static const QString authorsFilePath ()
 Returns the path to the authors file. More...
 
static QString buildOutputPath ()
 Returns path to the build output directory. More...
 
static QString buildSourcePath ()
 Returns path to the source directory. More...
 
static const QString contributorsFilePath ()
 Returns the path to the contributors file. More...
 
static bool createDB (QString *errorMessage=0)
 initialise qgis.db More...
 
static const QString defaultStyleV2Path ()
 Returns the path to default style (works as a starting point). More...
 
static const QString defaultThemePath ()
 Returns the path to the default theme directory. More...
 
static const QString developersMapFilePath ()
 Returns the path to the developers map file. More...
 
static const 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 QIcon getThemeIcon (const QString &theName)
 Helper to get a theme icon. More...
 
static QPixmap getThemePixmap (const QString &theName)
 Helper to get a theme icon as a pixmap. More...
 
static const QString helpAppPath ()
 Returns the path to the help application. More...
 
static const QString i18nPath ()
 Returns the path to the translation directory. More...
 
static QString iconPath (QString iconFile)
 Returns path to the desired icon file. More...
 
static const QString iconsPath ()
 Returns the path to the icons image directory. More...
 
static void init (QString customConfigPath=QString())
 This method initialises paths etc for QGIS. More...
 
static void initQgis ()
 loads providers More...
 
static bool isRunningFromBuildDir ()
 Indicates whether running from build directory (not installed) More...
 
static const QString libexecPath ()
 Returns the path with utility executables (help viewer, crssync, ...) More...
 
static const QString libraryPath ()
 Returns the path containing qgis_core, qgis_gui, qgispython (and other) libraries. More...
 
static const QString licenceFilePath ()
 Returns the path to the licence file. More...
 
static int maxThreads ()
 Get maximum concurrent thread count. More...
 
static const QString pkgDataPath ()
 Returns the common root path of all application data directories. More...
 
static const QString pluginPath ()
 Returns the path to the application plugin directory. More...
 
static const QString prefixPath ()
 Returns the path to the application prefix directory. More...
 
static const QString qgisMasterDbFilePath ()
 Returns the path to the master qgis.db file. More...
 
static const QString qgisSettingsDirPath ()
 Returns the path to the settings directory in user's home dir. More...
 
static const QString qgisUserDbFilePath ()
 Returns the path to the user qgis.db file. More...
 
static void registerOgrDrivers ()
 Register OGR drivers ensuring this only happens once. More...
 
static QString relativePathToAbsolutePath (QString rpath, QString targetPath)
 Converts path relative to target to an absolute path. More...
 
static QString reportStyleSheet ()
 get a standard css style sheet for reports. More...
 
static void restoreGdalDriver (QString theDriver)
 Sets the GDAL_SKIP environment variable to exclude the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. More...
 
static void setDefaultSvgPaths (const QStringList &pathList)
 Alters default svg paths - used by 3rd party apps. More...
 
static void setFileOpenEventReceiver (QObject *receiver)
 Set the FileOpen event receiver. More...
 
static void setMaxThreads (int maxThreads)
 Set maximum concurrent thread count. More...
 
static void setPkgDataPath (const QString &thePkgDataPath)
 Alters pkg data path - used by 3rd party apps. More...
 
static void setPluginPath (const QString &thePluginPath)
 Alters plugin path - used by 3rd party apps. More...
 
static void setPrefixPath (const QString &thePrefixPath, bool useDefaultPaths=false)
 Alters prefix path - used by 3rd party apps. More...
 
static void setThemeName (const QString &theThemeName)
 Set the active theme to the specified theme. 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 (QString theDriver)
 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 const QString splashPath ()
 Returns the path to the splash screen image directory. More...
 
static const QString sponsorsFilePath ()
 Returns the path to the sponsors file. More...
 
static const QString srsDbFilePath ()
 Returns the path to the srs.db file. More...
 
static const QStringList svgPaths ()
 Returns the pathes to svg directories. More...
 
static const QMap< QString, QStringsystemEnvVars ()
 Returns the system environment variables passed to application. More...
 
static const QString themeName ()
 Set the active theme to the specified theme. More...
 
static const QString translatorsFilePath ()
 Returns the path to the sponsors file. More...
 
static const QString userStyleV2Path ()
 Returns the path to user's style. More...
 
static const QString whatsNewFilePath ()
 Returns the path to the whats new html page. More...
 
- Static Public Member Functions inherited from QApplication
void aboutQt ()
 
QWidgetactiveModalWidget ()
 
QWidgetactivePopupWidget ()
 
QWidgetactiveWindow ()
 
void alert (QWidget *widget, int msec)
 
QWidgetList allWidgets ()
 
void beep ()
 
void changeOverrideCursor (const QCursor &cursor)
 
QClipboardclipboard ()
 
void closeAllWindows ()
 
ColorMode colorMode ()
 
int colorSpec ()
 
int cursorFlashTime ()
 
QDesktopWidgetdesktop ()
 
bool desktopSettingsAware ()
 
int doubleClickInterval ()
 
int exec ()
 
void flushX ()
 
QWidgetfocusWidget ()
 
QFont font (const QWidget *widget)
 
QFont font ()
 
QFont font (const char *className)
 
QFontMetrics fontMetrics ()
 
QSize globalStrut ()
 
bool hasGlobalMouseTracking ()
 
Qt::Alignment horizontalAlignment (QFlags< Qt::AlignmentFlag > align)
 
bool isEffectEnabled (Qt::UIEffect effect)
 
bool isLeftToRight ()
 
bool isRightToLeft ()
 
Qt::LayoutDirection keyboardInputDirection ()
 
int keyboardInputInterval ()
 
QLocale keyboardInputLocale ()
 
Qt::KeyboardModifiers keyboardModifiers ()
 
bool keypadNavigationEnabled ()
 
Qt::LayoutDirection layoutDirection ()
 
Qt::MacintoshVersion macVersion ()
 
QWidgetmainWidget ()
 
Qt::MouseButtons mouseButtons ()
 
Qt::NavigationMode navigationMode ()
 
QCursoroverrideCursor ()
 
QPalette palette (const QWidget *widget)
 
QPalette palette ()
 
QPalette palette (const char *className)
 
Qt::KeyboardModifiers queryKeyboardModifiers ()
 
bool quitOnLastWindowClosed ()
 
QDecorationqwsDecoration ()
 
void qwsSetDecoration (QDecoration *decoration)
 
QDecorationqwsSetDecoration (const QString &decoration)
 
void restoreOverrideCursor ()
 
bool reverseLayout ()
 
void setActiveWindow (QWidget *active)
 
void setColorMode (ColorMode mode)
 
void setColorSpec (int spec)
 
void setCursorFlashTime (int)
 
void setDesktopSettingsAware (bool on)
 
void setDoubleClickInterval (int)
 
void setEffectEnabled (Qt::UIEffect effect, bool enable)
 
void setFont (const QFont &font, bool b, const char *className)
 
void setFont (const QFont &font, const char *className)
 
void setGlobalMouseTracking (bool dummy)
 
void setGlobalStrut (const QSize &)
 
void setGraphicsSystem (const QString &system)
 
void setKeyboardInputInterval (int)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setMainWidget (QWidget *mainWidget)
 
void setNavigationMode (Qt::NavigationMode mode)
 
void setOverrideCursor (const QCursor &cursor)
 
void setOverrideCursor (const QCursor &cursor, bool replace)
 
void setPalette (const QPalette &pal, bool b, const char *className)
 
void setPalette (const QPalette &palette, const char *className)
 
void setQuitOnLastWindowClosed (bool quit)
 
void setReverseLayout (bool reverse)
 
void setStartDragDistance (int l)
 
void setStartDragTime (int ms)
 
void setStyle (QStyle *style)
 
QStylesetStyle (const QString &style)
 
void setWheelScrollLines (int)
 
void setWindowIcon (const QIcon &icon)
 
void setWinStyleHighlightColor (const QColor &c)
 
int startDragDistance ()
 
int startDragTime ()
 
QStylestyle ()
 
void syncX ()
 
QWidgettopLevelAt (const QPoint &point)
 
QWidgettopLevelAt (int x, int y)
 
QWidgetList topLevelWidgets ()
 
Type type ()
 
int wheelScrollLines ()
 
QWidgetwidgetAt (const QPoint &point)
 
QWidgetwidgetAt (int x, int y, bool child)
 
QWidgetwidgetAt (const QPoint &point, bool child)
 
QWidgetwidgetAt (int x, int y)
 
QIcon windowIcon ()
 
const QColorwinStyleHighlightColor ()
 
Qt::WindowsVersion winVersion ()
 
- Static Public Member Functions inherited from QCoreApplication
void addLibraryPath (const QString &path)
 
QString applicationDirPath ()
 
QString applicationFilePath ()
 
QString applicationName ()
 
qint64 applicationPid ()
 
QString applicationVersion ()
 
int argc ()
 
QStringList arguments ()
 
char ** argv ()
 
bool closingDown ()
 
int enter_loop ()
 
int exec ()
 
void exit (int returnCode)
 
void exit_loop ()
 
void flush ()
 
bool hasPendingEvents ()
 
void installTranslator (QTranslator *translationFile)
 
QCoreApplicationinstance ()
 
QStringList libraryPaths ()
 
int loopLevel ()
 
QString organizationDomain ()
 
QString organizationName ()
 
void postEvent (QObject *receiver, QEvent *event)
 
void postEvent (QObject *receiver, QEvent *event, int priority)
 
void processEvents (QFlags< QEventLoop::ProcessEventsFlag > flags)
 
void processEvents (QFlags< QEventLoop::ProcessEventsFlag > flags, int maxtime)
 
void processOneEvent ()
 
void quit ()
 
void removeLibraryPath (const QString &path)
 
void removePostedEvents (QObject *receiver, int eventType)
 
void removePostedEvents (QObject *receiver)
 
void removeTranslator (QTranslator *translationFile)
 
bool sendEvent (QObject *receiver, QEvent *event)
 
void sendPostedEvents (QObject *receiver, int event_type)
 
void sendPostedEvents ()
 
void setApplicationName (const QString &application)
 
void setApplicationVersion (const QString &version)
 
void setAttribute (Qt::ApplicationAttribute attribute, bool on)
 
void setLibraryPaths (const QStringList &paths)
 
void setOrganizationDomain (const QString &orgDomain)
 
void setOrganizationName (const QString &orgName)
 
bool startingUp ()
 
bool testAttribute (Qt::ApplicationAttribute attribute)
 
QString translate (const char *context, const char *sourceText, const char *disambiguation, Encoding encoding, int n)
 
QString translate (const char *context, const char *sourceText, const char *disambiguation, Encoding encoding)
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Static Public Attributes

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

Additional Inherited Members

- Public Attributes inherited from QApplication
typedef ColorMode
 
typedef QS60MainApplicationFactory
 
- Public Attributes inherited from QCoreApplication
typedef EventFilter
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QApplication
 autoMaximizeThreshold
 
 autoSipEnabled
 
 cursorFlashTime
 
 doubleClickInterval
 
 globalStrut
 
 keyboardInputInterval
 
 layoutDirection
 
 quitOnLastWindowClosed
 
 startDragDistance
 
 startDragTime
 
 styleSheet
 
 wheelScrollLines
 
 windowIcon
 
- Properties inherited from QCoreApplication
 applicationName
 
 applicationVersion
 
 organizationDomain
 
 organizationName
 
- Properties inherited from QObject
 objectName
 

Detailed Description

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

The QgsApplication class manages application-wide information.

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

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

Definition at line 34 of file qgsapplication.h.

Member Typedef Documentation

Constants for endian-ness.

Constructor & Destructor Documentation

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

Definition at line 88 of file qgsapplication.cpp.

QgsApplication::~QgsApplication ( )
virtual

Definition at line 208 of file qgsapplication.cpp.

Member Function Documentation

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

Converts absolute path to path relative to target.

Definition at line 785 of file qgsapplication.cpp.

const QString QgsApplication::activeThemePath ( )
static

Returns the path to the currently active theme directory.

Definition at line 356 of file qgsapplication.cpp.

void QgsApplication::applyGdalSkippedDrivers ( )
static

Apply the skipped drivers list to gdal.

See also
skipGdalDriver
restoreGdalDriver
skippedGdalDrivers

Definition at line 919 of file qgsapplication.cpp.

const QString QgsApplication::authorsFilePath ( )
static

Returns the path to the authors file.

Returns the path to the authors file.

Definition at line 436 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 261 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 259 of file qgsapplication.h.

const QString QgsApplication::contributorsFilePath ( )
static

Returns the path to the contributors file.

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

Returns the path to the contributors file.

Definition at line 443 of file qgsapplication.cpp.

bool QgsApplication::createDB ( QString errorMessage = 0)
static

initialise qgis.db

Definition at line 929 of file qgsapplication.cpp.

const QString QgsApplication::defaultStyleV2Path ( )
static

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

Definition at line 601 of file qgsapplication.cpp.

const QString QgsApplication::defaultThemePath ( )
static

Returns the path to the default theme directory.

Definition at line 352 of file qgsapplication.cpp.

const QString QgsApplication::developersMapFilePath ( )
static

Returns the path to the developers map file.

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

Note
this function was added in version 2.7

Definition at line 447 of file qgsapplication.cpp.

const QString QgsApplication::donorsFilePath ( )
static

Returns the path to the donors file.

Returns the path to the donors file.

Definition at line 467 of file qgsapplication.cpp.

QgsApplication::endian_t QgsApplication::endian ( )
static

Returns whether this machine uses big or little endian.

Definition at line 616 of file qgsapplication.cpp.

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

Swap the endianness of the specified value.

Definition at line 216 of file qgsapplication.h.

bool QgsApplication::event ( QEvent event)
overridevirtual

Watch for QFileOpenEvent.

Reimplemented from QApplication.

Definition at line 212 of file qgsapplication.cpp.

void QgsApplication::exitQgis ( )
static

deletes provider registry and map layer registry

Definition at line 630 of file qgsapplication.cpp.

QIcon QgsApplication::getThemeIcon ( const QString theName)
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 373 of file qgsapplication.cpp.

QPixmap QgsApplication::getThemePixmap ( const QString theName)
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 394 of file qgsapplication.cpp.

const QString QgsApplication::helpAppPath ( )
static

Returns the path to the help application.

Returns the path to the help application.

Definition at line 487 of file qgsapplication.cpp.

const QString QgsApplication::i18nPath ( )
static

Returns the path to the translation directory.

Returns the path to the translation directory.

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

const QString QgsApplication::iconsPath ( )
static

Returns the path to the icons image directory.

Returns the path to the icons image directory.

Definition at line 547 of file qgsapplication.cpp.

void QgsApplication::init ( QString  customConfigPath = QString())
static

This method initialises paths etc for QGIS.

Called by the ctor or call it manually when your app does not extend the QApplication class.

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

Definition at line 94 of file qgsapplication.cpp.

void QgsApplication::initQgis ( )
static

loads providers

Definition at line 621 of file qgsapplication.cpp.

static bool QgsApplication::isRunningFromBuildDir ( )
inlinestatic

Indicates whether running from build directory (not installed)

Definition at line 254 of file qgsapplication.h.

const QString QgsApplication::libexecPath ( )
static

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

Definition at line 611 of file qgsapplication.cpp.

const QString QgsApplication::libraryPath ( )
static

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

Definition at line 606 of file qgsapplication.cpp.

const QString QgsApplication::licenceFilePath ( )
static

Returns the path to the licence file.

Returns the path to the licence file.

Definition at line 479 of file qgsapplication.cpp.

static int QgsApplication::maxThreads ( )
inlinestatic

Get maximum concurrent thread count.

Note
added in 2.4

Definition at line 288 of file qgsapplication.h.

bool QgsApplication::notify ( QObject receiver,
QEvent event 
)
overridevirtual

Catch exceptions when sending event to receiver.

Reimplemented from QApplication.

Definition at line 240 of file qgsapplication.cpp.

const QString QgsApplication::pkgDataPath ( )
static

Returns the common root path of all application data directories.

Definition at line 348 of file qgsapplication.cpp.

const QString QgsApplication::pluginPath ( )
static

Returns the path to the application plugin directory.

Definition at line 344 of file qgsapplication.cpp.

const QString QgsApplication::prefixPath ( )
static

Returns the path to the application prefix directory.

Definition at line 332 of file qgsapplication.cpp.

void QgsApplication::preNotify ( QObject receiver,
QEvent event,
bool *  done 
)
signal
Note
not available in python bindings
const QString QgsApplication::qgisMasterDbFilePath ( )
static

Returns the path to the master qgis.db file.

Returns the path to the master qgis.db file.

Definition at line 515 of file qgsapplication.cpp.

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

const QString QgsApplication::qgisUserDbFilePath ( )
static

Returns the path to the user qgis.db file.

Returns the path to the user qgis.db file.

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

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

Converts path relative to target to an absolute path.

Definition at line 848 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);

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

void QgsApplication::restoreGdalDriver ( QString  theDriver)
static

Sets the GDAL_SKIP environment variable to exclude the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it.

The driver name should be the short format of the Gdal driver name e.g. GTIFF.

Definition at line 905 of file qgsapplication.cpp.

void QgsApplication::setDefaultSvgPaths ( const QStringList pathList)
static

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

Definition at line 327 of file qgsapplication.cpp.

void QgsApplication::setFileOpenEventReceiver ( QObject receiver)
static

Set the FileOpen event receiver.

Definition at line 278 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
added in 2.4

Definition at line 1060 of file qgsapplication.cpp.

void QgsApplication::setPkgDataPath ( const QString thePkgDataPath)
static

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

Definition at line 318 of file qgsapplication.cpp.

void QgsApplication::setPluginPath ( const QString thePluginPath)
static

Alters plugin path - used by 3rd party apps.

Definition at line 313 of file qgsapplication.cpp.

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

Alters prefix path - used by 3rd party apps.

Definition at line 295 of file qgsapplication.cpp.

void QgsApplication::setThemeName ( const QString theThemeName)
static

Set the active theme to the specified theme.

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

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

Set the theme path to the specified theme.

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

void QgsApplication::skipGdalDriver ( QString  theDriver)
static

Sets the GDAL_SKIP environment variable to include the specified driver and then calls GDALDriverManager::AutoSkipDrivers() to unregister it.

The driver name should be the short format of the Gdal driver name e.g. GTIFF.

Definition at line 895 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 278 of file qgsapplication.h.

const QString QgsApplication::splashPath ( )
static

Returns the path to the splash screen image directory.

Returns the path to the splash screen image directory.

Definition at line 539 of file qgsapplication.cpp.

const QString QgsApplication::sponsorsFilePath ( )
static

Returns the path to the sponsors file.

Returns the path to the sponsors file.

Definition at line 459 of file qgsapplication.cpp.

const QString QgsApplication::srsDbFilePath ( )
static

Returns the path to the srs.db file.

Returns the path to the srs.db file.

Definition at line 554 of file qgsapplication.cpp.

const QStringList QgsApplication::svgPaths ( )
static

Returns the pathes to svg directories.

Returns the paths to the svg directories.

Definition at line 580 of file qgsapplication.cpp.

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

Returns the system environment variables passed to application.

Definition at line 141 of file qgsapplication.h.

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

const QString QgsApplication::translatorsFilePath ( )
static

Returns the path to the sponsors file.

Definition at line 473 of file qgsapplication.cpp.

const QString QgsApplication::userStyleV2Path ( )
static

Returns the path to user's style.

Definition at line 596 of file qgsapplication.cpp.

const QString QgsApplication::whatsNewFilePath ( )
static

Returns the path to the whats new html page.

Note
this function was added in version 2.11

Definition at line 452 of file qgsapplication.cpp.

Member Data Documentation

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

Definition at line 40 of file qgsapplication.h.

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

Definition at line 39 of file qgsapplication.h.

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

Definition at line 38 of file qgsapplication.h.


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