Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

ScPaths Class Reference

#include <scpaths.h>

Collaboration diagram for ScPaths:

Collaboration graph
[legend]

List of all members.

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.
QString translationDir () const
 Return path to the translations directory.
QString dictDir () const
 Return path to the dicts directory.

Static Public Member Functions

static const ScPathsinstance ()
 Get a reference to the ScPaths instance creating it if necessary.
static void destroy ()
 Destroy the ScPaths instance, if any.
static QString separatorsToSlashes (const QString &path)
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 QString getApplicationDataDir (void)
 Return path to application data dir.
static QString getUserDocumentDir (void)
 Return path to user documents.
static QString getTempFileDir (void)
 Return path to directory used for temporary files.

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_iconDir
QString m_fontDir
QString m_libDir
QString m_pluginDir
QString m_sampleScriptDir
QString m_scriptDir
QString m_templateDir
QString m_shareDir

Static Protected Attributes

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


Detailed Description

Definition at line 14 of file scpaths.h.


Constructor & Destructor Documentation

ScPaths::ScPaths (  )  [protected]

Constructor. Use ScPaths::instance() instead.

Definition at line 52 of file scpaths.cpp.

References m_docDir, m_fontDir, m_iconDir, m_libDir, m_pluginDir, m_sampleScriptDir, m_scriptDir, m_shareDir, m_templateDir, and p.

Referenced by instance().

ScPaths::~ScPaths (  )  [protected]

Destructor. Use ScPaths::destroy() instead.

Definition at line 142 of file scpaths.cpp.


Member Function Documentation

const ScPaths & ScPaths::instance (  )  [static]

void ScPaths::destroy (  )  [static]

Destroy the ScPaths instance, if any.

See also:
ScPaths::instnace()

Definition at line 43 of file scpaths.cpp.

QString ScPaths::separatorsToSlashes ( const QString &  path  )  [static]

const QString & ScPaths::docDir (  )  const

Return path to documentation directory.

Definition at line 151 of file scpaths.cpp.

References m_docDir.

Referenced by HelpBrowser::HelpBrowser(), and HelpBrowser::loadMenu().

const QString & ScPaths::iconDir (  )  const

Return path to icons directory.

Definition at line 156 of file scpaths.cpp.

References m_iconDir.

Referenced by UndoManager::initIcons().

const QString & ScPaths::fontDir (  )  const

Return path to the Scribus font directory.

Definition at line 161 of file scpaths.cpp.

References m_fontDir.

Referenced by SCFonts::GetFonts().

const QString & ScPaths::libDir (  )  const

Return path to lib directory containing translations, keysets, etc.

Definition at line 166 of file scpaths.cpp.

References m_libDir.

Referenced by EPSPlug::convert(), ColorSetManager::findPaletteLocations(), ScribusCore::getCMSProfiles(), hasAntiword(), ColorSetManager::initialiseDefaultPrefs(), ColorManager::loadDefaults(), and CMYKChoose::SelSwatch().

const QString & ScPaths::pluginDir (  )  const

Return path to dir containing plugins.

Definition at line 171 of file scpaths.cpp.

References m_pluginDir.

Referenced by gtGetText::loadImporterPlugins().

const QString & ScPaths::sampleScriptDir (  )  const

Return path to dir containing sample Python scripts.

Definition at line 176 of file scpaths.cpp.

References m_sampleScriptDir.

const QString & ScPaths::scriptDir (  )  const

Return path to dir containing "official" Python scripts.

Definition at line 181 of file scpaths.cpp.

References m_scriptDir.

Referenced by ScripterCore::buildScribusScriptsMenu(), and ScripterCore::StdScript().

const QString & ScPaths::templateDir (  )  const

Return path to containing stock templates.

Definition at line 186 of file scpaths.cpp.

References m_templateDir.

Referenced by nftsettings::nftsettings(), and satdialog::setupCategories().

const QString & ScPaths::shareDir (  )  const

Return path to the Scribus share directory.

Definition at line 191 of file scpaths.cpp.

References m_shareDir.

Referenced by LatexConfigCache::defaultConfigs(), TabKeyboardShortcutsWidget::resetKeySet(), and TabKeyboardShortcutsWidget::scanForSets().

QString ScPaths::translationDir (  )  const

Return path to the translations directory.

Definition at line 196 of file scpaths.cpp.

References m_shareDir.

Referenced by LanguageManager::generateInstalledLangList().

QString ScPaths::dictDir (  )  const

Return path to the dicts directory.

Definition at line 201 of file scpaths.cpp.

References m_shareDir.

Referenced by Hyphenator::Hyphenator(), and Hyphenator::NewDict().

QStringList ScPaths::getSystemFontDirs ( void   )  [static]

Return paths to system font directories.

Definition at line 206 of file scpaths.cpp.

References getSpecialDir().

Referenced by SCFonts::GetFonts().

QStringList ScPaths::getSystemProfilesDirs ( void   )  [static]

Return paths to system icc profiles directories.

Definition at line 220 of file scpaths.cpp.

Referenced by ScribusCore::getCMSProfiles().

QStringList ScPaths::getSystemCreateSwatchesDirs ( void   )  [static]

Return paths to system create project directories.

Definition at line 256 of file scpaths.cpp.

References getSpecialDir().

Referenced by ColorSetManager::findPaletteLocations().

QString ScPaths::getApplicationDataDir ( void   )  [static]

QString ScPaths::getUserDocumentDir ( void   )  [static]

Return path to user documents.

Definition at line 292 of file scpaths.cpp.

References getSpecialDir().

Referenced by PrefsManager::initDefaults().

QString ScPaths::getTempFileDir ( void   )  [static]

QString ScPaths::getSpecialDir ( int  folder  )  [static, protected]

Return path to a special directory, should be used only on Windows.

Definition at line 324 of file scpaths.cpp.

Referenced by getApplicationDataDir(), getSystemCreateSwatchesDirs(), getSystemFontDirs(), getTempFileDir(), and getUserDocumentDir().


Member Data Documentation

const char ScPaths::envPathSeparator = ':' [static]

ScPaths * ScPaths::m_instance = NULL [static, protected]

Pointer to existing instance of ScPaths, if any.

Definition at line 84 of file scpaths.h.

QString ScPaths::m_docDir [protected]

Definition at line 87 of file scpaths.h.

Referenced by docDir(), and ScPaths().

QString ScPaths::m_iconDir [protected]

Definition at line 88 of file scpaths.h.

Referenced by iconDir(), and ScPaths().

QString ScPaths::m_fontDir [protected]

Definition at line 89 of file scpaths.h.

Referenced by fontDir(), and ScPaths().

QString ScPaths::m_libDir [protected]

Definition at line 90 of file scpaths.h.

Referenced by libDir(), and ScPaths().

QString ScPaths::m_pluginDir [protected]

Definition at line 91 of file scpaths.h.

Referenced by pluginDir(), and ScPaths().

QString ScPaths::m_sampleScriptDir [protected]

Definition at line 92 of file scpaths.h.

Referenced by sampleScriptDir(), and ScPaths().

QString ScPaths::m_scriptDir [protected]

Definition at line 93 of file scpaths.h.

Referenced by ScPaths(), and scriptDir().

QString ScPaths::m_templateDir [protected]

Definition at line 94 of file scpaths.h.

Referenced by ScPaths(), and templateDir().

QString ScPaths::m_shareDir [protected]

Definition at line 95 of file scpaths.h.

Referenced by dictDir(), ScPaths(), shareDir(), and translationDir().


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.