blob: 15d813a1114fca4d7a371a6f5e14ef86f2005ab0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
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:
/**
* @brief Get a reference to the ScPaths instance
* creating it if necessary.
* @sa ScPaths::destroy()
*/
static const ScPaths& instance();
/**
* @brief Destroy the ScPaths instance, if any.
* @sa ScPaths::instnace()
*/
static void destroy();
/*** The separator used between path list entries in environment variables */
static const char envPathSeparator;
/** @brief Return path to documentation directory */
const QString& docDir() const;
/** @brief Return path to icons directory*/
const QString& iconDir() const;
/** @brief Return path to the Scribus font directory */
const QString& fontDir() const;
/** @brief Return path to lib directory containing translations,
* keysets, etc. */
const QString& libDir() const;
/** @brief Return path to dir containing plugins. */
const QString& pluginDir() const;
/** @brief Return path to dir containing sample Python scripts */
const QString& sampleScriptDir() const;
/** @brief Return path to dir containing "official" Python scripts */
const QString& scriptDir() const;
/** @brief Return path to containing stock templates */
const QString& templateDir() const;
/** @brief Return path to the Scribus share directory */
const QString& shareDir() const;
/** @brief Return path to the translations directory */
QString translationDir() const;
/** @brief Return path to the dicts directory */
QString dictDir() const;
/** @brief Return path to the spelling dictionary directory */
QStringList spellDirs() const;
/** @brief Return paths to system font directories*/
static QStringList getSystemFontDirs(void);
/** @brief Return paths to system icc profiles directories*/
static QStringList getSystemProfilesDirs(void);
/** @brief Return paths to system create project directories*/
static QStringList getSystemCreateSwatchesDirs(void);
/** @brief Return path to application data dir*/
static QString getApplicationDataDir(void);
/** @brief Return path to application data dir for downloaded dictsionaries*/
static QString getUserDictDir(bool createIfNotExists);
/** @brief Return path to user documents*/
static QString getUserDocumentDir(void);
/** @brief Return path to directory used for temporary files*/
static QString getTempFileDir(void);
/** @brief Return path to directory used for downloaded (permanent) files*/
static QString downloadDir(void);
/** @brief Return path to Contents OSX subdirectory*/
QString bundleDir(void) const;
protected:
/** @brief Constructor. Use ScPaths::instance() instead. */
ScPaths();
/** @brief Destructor. Use ScPaths::destroy() instead. */
~ScPaths();
/** @brief Return path to a special directory, should be used only on Windows*/
static QString getSpecialDir(int folder);
/** @brief Pointer to existing instance of ScPaths, if any. */
static ScPaths* m_instance;
// Members to hold system paths
QString m_docDir;
QString m_iconDir;
QString m_fontDir;
QString m_libDir;
QString m_pluginDir;
QString m_sampleScriptDir;
QString m_scriptDir;
QString m_templateDir;
QString m_shareDir;
};
#endif
|
