qgsapplication.h

Go to the documentation of this file.

/***************************************************************************
    qgsapplication.h - Accessors for application-wide data
     --------------------------------------
    Date                 : 02-Jan-2006
    Copyright            : (C) 2006 by Tom Elwertowski
    Email                : telwertowski at users dot sourceforge dot net
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSAPPLICATION_H
#define QGSAPPLICATION_H

#include <QApplication>
#include <QEvent>
#include <QStringList>

#include <qgis.h>
#include <qgsconfig.h>

#ifdef ANDROID
typedef void XEvent;
#endif

class CORE_EXPORT QgsApplication : public QApplication
{
    Q_OBJECT
  public:
    static const char* QGIS_ORGANIZATION_NAME;
    static const char* QGIS_ORGANIZATION_DOMAIN;
    static const char* QGIS_APPLICATION_NAME;
    QgsApplication( int & argc, char ** argv, bool GUIenabled, const QString& customConfigPath = QString(), const QString& platformName = "desktop" );
    virtual ~QgsApplication();

    static void init( QString customConfigPath = QString() );

    virtual bool event( QEvent * event ) override;

    virtual bool notify( QObject * receiver, QEvent * event ) override;

    static void setFileOpenEventReceiver( QObject * receiver );

    static void setThemeName( const QString &theThemeName );

    static QString themeName();

    static void setUITheme( const QString &themeName );

    static QHash<QString, QString> uiThemes();

    static QString authorsFilePath();

    static QString contributorsFilePath();

    static QString developersMapFilePath();

    static QString sponsorsFilePath();

    static QString donorsFilePath();

    static QString translatorsFilePath();

    static QString licenceFilePath();

    static QString helpAppPath();

    static QString i18nPath();

    static QString qgisMasterDbFilePath();

    static QString qgisSettingsDirPath();

    static QString qgisUserDbFilePath();

    static QString qgisAuthDbFilePath();

    static QString splashPath();

    static QString iconsPath();

    static QString srsDbFilePath();

    static QStringList svgPaths();

    static QStringList composerTemplatePaths();

    static QMap<QString, QString> systemEnvVars() { return ABISYM( mSystemEnvVars ); }

    static QString prefixPath();

    static QString pluginPath();

    static QString pkgDataPath();

    static QString activeThemePath();

    static QString defaultThemePath();

    static QString iconPath( const QString& iconFile );

    static QIcon getThemeIcon( const QString &theName );

    static QPixmap getThemePixmap( const QString &theName );

    static QString userStyleV2Path();

    static QRegExp shortNameRegExp();

    static QString userLoginName();

    static QString userFullName();

    static QString osName();

    static QString platform();

    static QString userThemesFolder();

    static QString defaultStyleV2Path();

    static QString defaultThemesFolder();

    static QString libraryPath();

    static QString libexecPath();

    static void setPrefixPath( const QString &thePrefixPath, bool useDefaultPaths = false );

    static void setPluginPath( const QString &thePluginPath );

    static void setPkgDataPath( const QString &thePkgDataPath );

    static void setDefaultSvgPaths( const QStringList& pathList );

    static void setAuthDbDirPath( const QString& theAuthDbDirPath );

    static void initQgis();

    static bool createDB( QString* errorMessage = nullptr );

    static bool createThemeFolder();

    static void exitQgis();

    static QString appIconPath();

    enum endian_t
    {
      XDR = 0,  // network, or big-endian, byte order
      NDR = 1   // little-endian byte order
    };

    static endian_t endian();

    template<typename T>
    static void endian_swap( T& value )
    {
      char* data = reinterpret_cast<char*>( &value );
      std::size_t n = sizeof( value );
      for ( std::size_t i = 0, m = n / 2; i < m; ++i )
      {
        std::swap( data[i], data[n - 1 - i] );
      }
    }

    static QString reportStyleSheet();

    static QString showSettings();

    static void registerOgrDrivers();

    static QString absolutePathToRelativePath( const QString& apath, const QString& targetPath );
    static QString relativePathToAbsolutePath( const QString& rpath, const QString& targetPath );

    static bool isRunningFromBuildDir() { return ABISYM( mRunningFromBuildDir ); }
#ifdef _MSC_VER
    static QString cfgIntDir() { return ABISYM( mCfgIntDir ); }
#endif

    static QString buildSourcePath() { return ABISYM( mBuildSourcePath ); }
    static QString buildOutputPath() { return ABISYM( mBuildOutputPath ); }

    static void skipGdalDriver( const QString& theDriver );

    static void restoreGdalDriver( const QString& theDriver );

    static QStringList skippedGdalDrivers() { return ABISYM( mGdalSkipList ); }

    static void applyGdalSkippedDrivers();

    static int maxThreads() { return ABISYM( mMaxThreads ); }

    static void setMaxThreads( int maxThreads );

#ifdef ANDROID
    //dummy method to workaround sip generation issue issue
    bool x11EventFilter( XEvent * event )
    {
      Q_UNUSED( event );
      return 0;
    }
#endif

  public slots:

    void emitSettingsChanged();

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

    void settingsChanged();

  private:
    static void copyPath( const QString& src, const QString& dst );
    static QObject* ABISYM( mFileOpenEventReceiver );
    static QStringList ABISYM( mFileOpenEventList );

    static QString ABISYM( mUIThemeName );
    static QString ABISYM( mPrefixPath );
    static QString ABISYM( mPluginPath );
    static QString ABISYM( mPkgDataPath );
    static QString ABISYM( mLibraryPath );
    static QString ABISYM( mLibexecPath );
    static QString ABISYM( mThemeName );
    static QStringList ABISYM( mDefaultSvgPaths );
    static QMap<QString, QString> ABISYM( mSystemEnvVars );

    static QString ABISYM( mConfigPath );

    static bool ABISYM( mRunningFromBuildDir );
    static QString ABISYM( mBuildSourcePath );
#ifdef _MSC_VER

    static QString ABISYM( mCfgIntDir );
#endif

    static QString ABISYM( mBuildOutputPath );
    static QStringList ABISYM( mGdalSkipList );
    static int ABISYM( mMaxThreads );
    static QString ABISYM( mAuthDbDirPath );

    static QString sUserName;
    static QString sUserFullName;
    static QString sPlatformName;

    QMap<QString, QIcon> mIconCache;
};

#endif