util::directory Namespace Reference

Namespaces
	anonymous_namespace{directory.cpp}

Functions
::qint64	getDirSizeRecursive (QString const &dir)
const QDir &	getDisplayTemplatesDir ()
QString	getHandbook ()
QString	getHowto ()
QDir const &	getIconDir ()
QString const &	getLicensePath ()
const QDir &	getLocaleDir ()
const QDir &	getPicsDir ()
const QDir &	getUserBaseDir ()
const QDir &	getUserCacheDir ()
const QDir &	getUserDisplayTemplatesDir ()
const QDir &	getUserHomeDir ()
const QDir &	getUserHomeSwordDir ()
const QDir &	getUserIndexDir ()
bool	initDirectoryCache ()
	Initializes the directory cache and returns whether it was successful. More...

Detailed Description

Tools for working with directories.

Function Documentation

getDirSizeRecursive()

qint64 util::directory::getDirSizeRecursive

(

QString const &

dir

)

Returns

the size of the directory including the size of all it's files and it's subdirs.

Returns the size of the directory including the size of all its files and its subdirs.

Todo:

Check if it's suitable for huge dir trees, as it holds a QDir object for each of it at the same time in the deepest recursion. For really deep dir tree this may lead to a stack overflow.

Returns

The size of the dir in bytes

Definition at line 226 of file directory.cpp.

References BT_ASSERT.

Referenced by CSwordModuleInfo::indexSize().

getDisplayTemplatesDir()

const QDir & util::directory::getDisplayTemplatesDir

(

)

Return the path to the default display template files.

Definition at line 330 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedDisplayTemplatesDir.

Referenced by CDisplayTemplateMgr::CDisplayTemplateMgr(), ColorManager::anonymous_namespace{colormanager.cpp}::createColorMaps(), and CDisplayTemplateMgr::fillTemplate().

getHandbook()

QString util::directory::getHandbook

(

)

Returns

an absolute path to a handbook or QString() if not found.

Definition at line 326 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::getDocFile().

Referenced by BibleTime::openOnlineHelp_Handbook().

getHowto()

QString util::directory::getHowto

(

)

Returns

an absolute path to a howto or QString() if not found.

Definition at line 328 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::getDocFile().

Referenced by BibleTime::openOnlineHelp_Howto().

getIconDir()

const QDir & util::directory::getIconDir

(

)

Return the path to the icons.

Definition at line 265 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedPrefix.

getLicensePath()

QString const & util::directory::getLicensePath

(

)

Return the path to the license.

Definition at line 272 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedPrefix.

Referenced by BtAboutDialog::BtAboutDialog().

getLocaleDir()

const QDir & util::directory::getLocaleDir

(

)

Return the path to the translation files.

Definition at line 283 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedLocaleDir.

Referenced by main().

getPicsDir()

const QDir & util::directory::getPicsDir

(

)

Return the path to the pictures.

Definition at line 279 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedPicsDir.

Referenced by BibleTime::BibleTime().

getUserBaseDir()

const QDir & util::directory::getUserBaseDir

(

)

Return the path to the user's settings directory.

Definition at line 334 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedUserBaseDir.

Referenced by BtBookmarksModelPrivate::defaultBookmarksFile(), and BtConfig::initBtConfig().

getUserCacheDir()

const QDir & util::directory::getUserCacheDir

(

)

Return the path to the user's cache directory.

Definition at line 346 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedUserCacheDir.

Referenced by CSwordLexiconModuleInfo::entries().

getUserDisplayTemplatesDir()

const QDir & util::directory::getUserDisplayTemplatesDir

(

)

Return the path to the user's custom display templates directory.

Definition at line 354 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedUserDisplayTemplatesDir.

Referenced by CDisplayTemplateMgr::CDisplayTemplateMgr(), and ColorManager::anonymous_namespace{colormanager.cpp}::createColorMaps().

getUserHomeDir()

const QDir & util::directory::getUserHomeDir

(

)

Return the path to the user's home directory. APPDATA% on Windows $HOME on linux

Definition at line 338 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedUserHomeDir.

Referenced by main().

getUserHomeSwordDir()

const QDir & util::directory::getUserHomeSwordDir

(

)

Return the path to the user's home .sword (or Sword) directory. APPDATA%\Sword on Windows $HOME.sword on linux

Definition at line 342 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedUserHomeSwordDir.

Referenced by BtInstallBackend::configPath(), BibleTimeApp::initBackends(), main(), and CSwordBackend::swordDirList().

getUserIndexDir()

const QDir & util::directory::getUserIndexDir

(

)

Return the path to the user's indices directory.

Definition at line 350 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::cachedUserIndexDir.

Referenced by CSwordModuleInfo::getGlobalBaseIndexLocation().

initDirectoryCache()

bool util::directory::initDirectoryCache

(

)

Initializes the directory cache and returns whether it was successful.

Note

When this function returns unsuccessfully, the program should exit.

Todo:

Check and comment whether this is needed:

Definition at line 67 of file directory.cpp.

References util::directory::anonymous_namespace{directory.cpp}::BIBLETIME, util::directory::anonymous_namespace{directory.cpp}::cachedDisplayTemplatesDir, util::directory::anonymous_namespace{directory.cpp}::cachedLocaleDir, util::directory::anonymous_namespace{directory.cpp}::cachedPicsDir, util::directory::anonymous_namespace{directory.cpp}::cachedPrefix, util::directory::anonymous_namespace{directory.cpp}::cachedUserBaseDir, util::directory::anonymous_namespace{directory.cpp}::cachedUserCacheDir, util::directory::anonymous_namespace{directory.cpp}::cachedUserDisplayTemplatesDir, util::directory::anonymous_namespace{directory.cpp}::cachedUserHomeDir, util::directory::anonymous_namespace{directory.cpp}::cachedUserHomeSwordDir, util::directory::anonymous_namespace{directory.cpp}::cachedUserIndexDir, and util::directory::anonymous_namespace{directory.cpp}::SWORD_DIR.

Referenced by main().