Scribus
Open source desktop publishing at your fingertips
ScPaths Class Reference
Collaboration diagram for ScPaths:

Public Types

enum  DictType { Hyph, Spell }
 

Public Member Functions

const QString & docDir () const
 Return path to documentation directory.
 
const QString & iconDir () const
 Return path to icons directory.
 
const QString & fontDir () const
 Return path to the Scribus font directory.
 
const QString & libDir () const
 Return path to lib directory containing translations, keysets, etc.
 
const QString & pluginDir () const
 Return path to dir containing plugins.
 
const QString & sampleScriptDir () const
 Return path to dir containing sample Python scripts.
 
const QString & scriptDir () const
 Return path to dir containing "official" Python scripts.
 
const QString & templateDir () const
 Return path to containing stock templates.
 
const QString & shareDir () const
 Return path to the Scribus share directory.
 
const QString & qmlDir () const
 Return path to the Scribus QML directory.
 
QString translationDir () const
 Return path to the translations directory.
 
QString dictDir () const
 Return path to the dicts directory.
 
QStringList spellDirs () const
 Return path to the spelling dictionary directory.
 
QStringList hyphDirs () const
 Return path to the hyphenation dictionary directory.
 
QString bundleDir (void) const
 Return path to Contents OSX subdirectory.
 

Static Public Member Functions

static const ScPathsinstance ()
 Get a reference to the ScPaths instance creating it if necessary. More...
 
static void destroy ()
 Destroy the ScPaths instance, if any. More...
 
static QStringList getSystemFontDirs (void)
 Return paths to system font directories.
 
static QStringList getSystemProfilesDirs (void)
 Return paths to system icc profiles directories.
 
static QStringList getSystemCreateSwatchesDirs (void)
 Return paths to system create project directories.
 
static QStringList getDirsFromEnvVar (const QString envVar, const QString dirToFind)
 Return paths to directories held in an environment variable.
 
static QString getApplicationDataDir (void)
 Return path to application data dir.
 
static QString getUserDictDir (ScPaths::DictType dictType, bool createIfNotExists)
 Return path to application data dir for downloaded hyph dictionaries.
 
static QString getUserFontDir (bool createIfNotExists)
 Return path to application data dir for downloaded fonts.
 
static QString getImageCacheDir (void)
 Return path to image cache dir.
 
static QString getPluginDataDir (void)
 Return path to plugin data dir.
 
static QString getUserDocumentDir (void)
 Return path to user documents.
 
static QString getTempFileDir (void)
 Return path to directory used for temporary files.
 
static QString downloadDir (void)
 Return path to directory used for downloaded (permanent) files.
 
static QString defaultImageEditorApp ()
 Until we get enough of these, lets have this here for now, gs stuff is in util_ghostscript.
 

Static Public Attributes

static const char envPathSeparator = ':'
 

Protected Member Functions

 ScPaths ()
 Constructor. Use ScPaths::instance() instead.
 
 ~ScPaths ()
 Destructor. Use ScPaths::destroy() instead.
 

Static Protected Member Functions

static QString getSpecialDir (int folder)
 Return path to a special directory, should be used only on Windows.
 

Protected Attributes

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
 

Static Protected Attributes

static ScPathsm_instance = NULL
 Pointer to existing instance of ScPaths, if any.
 

Member Function Documentation

void ScPaths::destroy ( )
static

Destroy the ScPaths instance, if any.

See also
ScPaths::instance()
const ScPaths & ScPaths::instance ( )
static

Get a reference to the ScPaths instance creating it if necessary.

See also
ScPaths::destroy()

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