swift::misc::CSwiftDirectories Class Reference

Locations of important directories for swift files. More...

#include <swiftdirectories.h>

Static Public Member Functions
static const QString &	binDirectory ()
	Returns the bin directory. On Windows/Linux this is the same directory as QCoreApplication::applicationDirPath(), but on MacOS the exceutable is located deeper in the hierarchy of the bundles.
static const QString &	pluginsDirectory ()
	Plugins directory.
static const QString &	audioPluginDirectory ()
	Audio plugins directory for Qt audio.
static const QString &	getXSwiftBusBuildDirectory ()
	The build directory.
static QString	executableFilePath (const QString &executable)
	The executable file path.
static const QString &	applicationDataDirectory ()
	swift application data directory, contains 0..n swift installation directories
static const QFileInfoList &	applicationDataDirectories ()
	swift application data sub directories
static int	applicationDataDirectoriesCount ()
	number of data directories (including this version)
static QFileInfoList	currentApplicationDataDirectories ()
	swift application data sub directories
static QStringList	applicationDataDirectoryList (bool withoutCurrent=false, bool decodedDirName=false)
	swift application data sub directories
static const QString &	normalizedApplicationDataDirectory ()
	swift application data directory for one specific installation (a version)
static const QString &	shareDirectory ()
	Where resource files (static DB files, ...) etc are located.
static const QString &	shareTestDirectory ()
	The test data directory.
static const QString &	shareTerrainProbeDirectory ()
	FSX/P3D terrain probe.
static const QString &	shareMatchingScriptDirectory ()
	Matching script examples directories.
static const QString &	bootstrapFileName ()
	Bootstrap file name.
static const QString &	bootstrapResourceFilePath ()
	Bootstrap resource file path.
static const QString &	staticDbFilesDirectory ()
	Where static DB files are located.
static const QString &	soundFilesDirectory ()
	Where sound files are located.
static const QString &	stylesheetsDirectory ()
	Where qss files are located.
static const QString &	htmlDirectory ()
	Where HTML files are located.
static const QString &	legalDirectory ()
	Where Legal files are located.
static const QString &	aboutFilePath ()
	The about document file location.
static const QString &	testFilesDirectory ()
	Where test files are located.
static const QString &	htmlTemplateFilePath ()
	HTML template.
static const QString &	documentationDirectory ()
	Directory where data can be stored.
static const QString &	logDirectory ()
	Directory for log files.
static const QString &	crashpadDirectory ()
	Directory for crashpad files.
static const QString &	crashpadDatabaseDirectory ()
	Directory for crashpad database files.
static const QString &	crashpadMetricsDirectory ()
	Directory for crashpad metrics files.
static QStringList	verifyRuntimeDirectoriesAndFiles ()
	Check if the (most important) runtime directories are available.
static QString	soundFilePathOrDefaultPath (const QString &directory, const QString &fileName)
	File path (with file name) of file name and.

Detailed Description

Locations of important directories for swift files.

Definition at line 19 of file swiftdirectories.h.

Member Function Documentation

applicationDataDirectory()

const QString & swift::misc::CSwiftDirectories::applicationDataDirectory ( )

static

swift application data directory, contains 0..n swift installation directories

Remarks

use CDirectoryUtils::normalizedApplicationDataDirectory for one specific version

audioPluginDirectory()

const QString & swift::misc::CSwiftDirectories::audioPluginDirectory ( )

static

Audio plugins directory for Qt audio.

Remarks

contains the audio plugins

getXSwiftBusBuildDirectory()

const QString & swift::misc::CSwiftDirectories::getXSwiftBusBuildDirectory ( )

static

The build directory.

Remarks

if is a local build

logDirectory()

const QString & swift::misc::CSwiftDirectories::logDirectory ( )

static

Directory for log files.

Remarks

In swift::misc so it can also be used from swift::misc classes

normalizedApplicationDataDirectory()

const QString & swift::misc::CSwiftDirectories::normalizedApplicationDataDirectory ( )

static

swift application data directory for one specific installation (a version)

Remarks

use CDirectoryUtils::applicationDataDirectory for one all swift versions

shareDirectory()

const QString & swift::misc::CSwiftDirectories::shareDirectory ( )

static

Where resource files (static DB files, ...) etc are located.

Remarks

share not shared (do no mix)

---

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

• src/misc/swiftdirectories.h