AppPaths Class Reference

Provides paths for various application components. More...

#include <app_paths.h>

Static Public Member Functions
static QString	appDir ()
	Returns the directory where the application is installed.
static QString	userDataDir ()
	Returns the user data directory.
static QString	userPluginDir ()
	Returns the user plugin directory.
static QString	userCacheDir ()
	Returns the user cache directory.
static QString	userAssetDir ()
	Returns the user asset directory.
static QString	bundledAssetDir ()
	Returns the bundled asset directory.
static QString	bundledPluginDir ()
	Returns the bundled plugin directory.
static QString	devAssetDir ()
	Returns the development asset directory.
static QString	devPluginDir ()
	Returns the development plugin directory.
static QString	icon (const QString &arg)
	Returns a specific icon based on the provided argument.
static QStringList	icons ()
	Returns a list of all available icons.
static QString	translation (const QString &arg)
	Returns a specific translation based on the provided argument.
static QStringList	translations ()
	Returns a list of all available translations.
static QString	theme (const QString &arg)
	Returns a specific theme based on the provided argument.
static QString	userThemes ()
	Returns the user themes directory.
static QStringList	themes ()
	Returns a list of all available themes.
static QStringList	fonts ()
	Returns a list of all available fonts.
static QStringList	libraries ()
	Returns a list of all available libraries.
static QStringList	templates ()
	Returns a list of all available templates.
static QStringList	assetSearchPaths ()
	Returns a list of directories to search for assets.
static QStringList	pluginSearchPaths ()
	Returns a list of directories to search for plugins.
static QString	findAsset (const QString &relativePath)
	Finds an asset file based on the relative path.
static QString	findPluginRoot (const QString &pluginIdOrFolderName)
	Finds the root directory of a plugin based on its ID or folder name.

Static Private Member Functions
static QStringList	envOverridePaths (const QString &name)
	Returns a list of environment override paths for the given name.

Detailed Description

Provides paths for various application components.

Member Function Documentation

appDir()

QString AppPaths::appDir ( )

static

Returns the directory where the application is installed.

Returns

QString The application directory path.

assetSearchPaths()

QStringList AppPaths::assetSearchPaths ( )

static

Returns a list of directories to search for assets.

Returns

QStringList A list of asset directory paths.

bundledAssetDir()

QString AppPaths::bundledAssetDir ( )

static

Returns the bundled asset directory.

Returns

QString The bundled asset directory path.

bundledPluginDir()

QString AppPaths::bundledPluginDir ( )

static

Returns the bundled plugin directory.

Returns

QString The bundled plugin directory path.

devAssetDir()

QString AppPaths::devAssetDir ( )

static

Returns the development asset directory.

Returns

QString The development asset directory path.

devPluginDir()

QString AppPaths::devPluginDir ( )

static

Returns the development plugin directory.

Returns

QString The development plugin directory path.

envOverridePaths()

QStringList AppPaths::envOverridePaths ( const QString & name )

staticprivate

Returns a list of environment override paths for the given name.

Parameters

name	The name of the environment variable.

Returns

QStringList A list of environment override paths.

findAsset()

QString AppPaths::findAsset ( const QString & relativePath )

static

Finds an asset file based on the relative path.

Parameters

relativePath

The relative path to the asset file.

Returns

QString The absolute path to the asset file.

findPluginRoot()

QString AppPaths::findPluginRoot ( const QString & pluginIdOrFolderName )

static

Finds the root directory of a plugin based on its ID or folder name.

Parameters

pluginIdOrFolderName

The identifier or folder name of the plugin.

Returns

QString The absolute path to the plugin root directory.

fonts()

QStringList AppPaths::fonts ( )

static

Returns a list of all available fonts.

Returns

QStringList A list of font file paths.

icon()

QString AppPaths::icon ( const QString & arg )

static

Returns a specific icon based on the provided argument.

Parameters

arg	The identifier for the icon.

Returns

QString The icon file path.

icons()

QStringList AppPaths::icons ( )

static

Returns a list of all available icons.

Returns

QStringList A list of icon file paths.

libraries()

QStringList AppPaths::libraries ( )

static

Returns a list of all available libraries.

Returns

QStringList A list of library file paths.

pluginSearchPaths()

QStringList AppPaths::pluginSearchPaths ( )

static

Returns a list of directories to search for plugins.

Returns

QStringList A list of plugin directory paths.

templates()

QStringList AppPaths::templates ( )

static

Returns a list of all available templates.

Returns

QStringList A list of template file paths.

theme()

QString AppPaths::theme ( const QString & arg )

static

Returns a specific theme based on the provided argument.

Parameters

arg	The identifier for the theme.

Returns

QString The theme directory path.

themes()

QStringList AppPaths::themes ( )

static

Returns a list of all available themes.

Returns

QStringList A list of theme directory paths.

translation()

QString AppPaths::translation ( const QString & arg )

static

Returns a specific translation based on the provided argument.

Parameters

arg	The identifier for the translation.

Returns

QString The translation file path.

translations()

QStringList AppPaths::translations ( )

static

Returns a list of all available translations.

Returns

QStringList A list of translation file paths.

userAssetDir()

QString AppPaths::userAssetDir ( )

static

Returns the user asset directory.

Returns

QString The user asset directory path.

userCacheDir()

QString AppPaths::userCacheDir ( )

static

Returns the user cache directory.

Returns

QString The user cache directory path.

userDataDir()

QString AppPaths::userDataDir ( )

static

Returns the user data directory.

Returns

QString The user data directory path.

userPluginDir()

QString AppPaths::userPluginDir ( )

static

Returns the user plugin directory.

Returns

QString The user plugin directory path.

userThemes()

QString AppPaths::userThemes ( )

static

Returns the user themes directory.

Returns

QString The user themes directory path.

---

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

• /__w/maki/maki/app/common/app_paths.h
• /__w/maki/maki/app/common/app_paths.cpp