scpaths.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/
#ifndef SCPATHS_H
#define SCPATHS_H

#include <QString>
#include <QStringList>
#include "scribusapi.h"

class SCRIBUS_API ScPaths
{
public:
    typedef enum {Hyph, Spell} DictType;

    static const ScPaths& instance();
    static void destroy();

    /*** The separator used between path list entries in environment variables */
    static const char envPathSeparator;

    const QString& docDir() const;
    const QString& iconDir() const;
    const QString& fontDir() const;
    const QString& libDir() const;
    const QString& pluginDir() const;
    const QString& sampleScriptDir() const;
    const QString& scriptDir() const;
    const QString& templateDir() const;
    const QString& shareDir() const;
    const QString& qmlDir() const;

    QString translationDir() const;
    QString dictDir() const;
    QStringList spellDirs() const;
    QStringList hyphDirs() const;

    static QStringList getSystemFontDirs(void);
    static QStringList getSystemProfilesDirs(void);
    static QStringList getSystemCreateSwatchesDirs(void);
    static QStringList getDirsFromEnvVar(const QString envVar, const QString dirToFind);
    static QString getApplicationDataDir(void);
    static QString getUserDictDir(ScPaths::DictType dictType, bool createIfNotExists);
    static QString getUserFontDir(bool createIfNotExists);
    static QString getImageCacheDir(void);
    static QString getPluginDataDir(void);
    static QString getUserDocumentDir(void);
    static QString getTempFileDir(void);
    static QString downloadDir(void);
    QString bundleDir(void) const;


    static QString defaultImageEditorApp();

protected:
    ScPaths();
    ~ScPaths();

    static QString getSpecialDir(int folder);

    static ScPaths* m_instance;

    // Members to hold system paths
    QString m_docDir;
    QString m_fontDir;
    QString m_iconDir;
    QString m_libDir;
    QString m_pluginDir;
    QString m_qmlDir;
    QString m_sampleScriptDir;
    QString m_scriptDir;
    QString m_shareDir;
    QString m_templateDir;
};
#endif