KStandardDirs Class Reference
Site-independent access to standard KDE directories. More...
#include <kstandarddirs.h>
Public Methods | |
KStandardDirs () | |
virtual | ~KStandardDirs () |
void | addPrefix (const QString &dir) |
void | addXdgConfigPrefix (const QString &dir) |
void | addXdgDataPrefix (const QString &dir) |
bool | addResourceType (const char *type, const QString &relativename) |
bool | addResourceDir (const char *type, const QString &absdir) |
QString | findResource (const char *type, const QString &filename) const |
bool | isRestrictedResource (const char *type, const QString &relPath=QString::null) const |
Q_UINT32 | calcResourceHash (const char *type, const QString &filename, bool deep) const |
QStringList | findDirs (const char *type, const QString &reldir) const |
QString | findResourceDir (const char *type, const QString &filename) const |
QStringList | findAllResources (const char *type, const QString &filter=QString::null, bool recursive=false, bool unique=false) const |
QStringList | findAllResources (const char *type, const QString &filter, bool recursive, bool unique, QStringList &relPaths) const |
void | addKDEDefaults () |
bool | addCustomized (KConfig *config) |
QStringList | resourceDirs (const char *type) const |
QStringList | allTypes () const |
QString | saveLocation (const char *type, const QString &suffix=QString::null, bool create=true) const |
QString | relativeLocation (const char *type, const QString &absPath) |
QString | kfsstnd_prefixes () |
QString | localkdedir () const |
QString | localxdgdatadir () const |
QString | localxdgconfdir () const |
Static Public Methods | |
QStringList | systemPaths (const QString &pstr=QString::null) |
QString | findExe (const QString &appname, const QString &pathstr=QString::null, bool ignoreExecBit=false) |
int | findAllExe (QStringList &list, const QString &appname, const QString &pathstr=QString::null, bool ignoreExecBit=false) |
bool | makeDir (const QString &dir, int mode=0755) |
QString | kde_default (const char *type) |
bool | exists (const QString &fullPath) |
QString | realPath (const QString &dirname) |
Related Functions | |
(Note that these are not member functions.) | |
QString | locate (const char *type, const QString &filename, const KInstance *instance=KGlobal::instance()) |
QString | locateLocal (const char *type, const QString &filename, const KInstance *instance=KGlobal::instance()) |
QString | locateLocal (const char *type, const QString &filename, bool createDir, const KInstance *instance=KGlobal::instance()) |
Detailed Description
Site-independent access to standard KDE directories.
- Author:
- Stephan Kulow <coolo@kde.org> and Sirtaj Singh Kang <taj@kde.org>
- Version:
- Id:
- kstandarddirs.h,v 1.111.2.1 2004/02/07 19:35:37 cschumac Exp
This is one of the most central classes in kdelibs as it provides a basic service: It knows where the files reside on the user's hard disk. And it's meant to be the only one that knows -- to make the real location as transparent as possible to both the user and the applications.
To this end it insulates the application from all information and applications always refer to a file with a resource type (e.g. icon) and a filename (e.g. khexdit.xpm). In an ideal world the application would make no assumption where this file is and leave it up to KStandardDirs::findResource("apps", "Home.desktop") to apply this knowledge to return /opt/kde/share/applnk/Home.desktop or locate("data", "kgame/background.jpg") to return /opt/kde/share/apps/kgame/background.jpg
The main idea behind KStandardDirs is that there are several toplevel prefixes below which the files lie. One of these prefixes is the one where the user installed kdelibs, one is where the application was installed, and one is $HOME/.kde, but there may be even more. Under these prefixes there are several well defined suffixes where specific resource types are to be found. For example, for the resource type "html" the suffixes could be share/doc/HTML and share/doc/kde/HTML. So the search algorithm basically appends to each prefix each registered suffix and tries to locate the file there. To make the thing even more complex, it's also possible to register absolute paths that KStandardDirs looks up after not finding anything in the former steps. They can be useful if the user wants to provide specific directories that aren't in his $HOME/.kde directory for, for example, icons.
Standard resources that kdelibs allocates are:
- apps - Applications menu (.desktop files).
- cache - Cached information (e.g. favicons, web-pages)
- cgi - CGIs to run from kdehelp.
- config - Configuration files.
- data - Where applications store data.
- exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
- html - HTML documentation.
- icon - Icons, see KIconLoader.
- kcfg - Configuration meta information files used by KConfig XT.
- lib - Libraries.
- locale - Translation files for KLocale.
- mime - Mime types.
- module - Module (dynamically loaded library).
- qtplugins - Qt plugins (dynamically loaded objects for Qt)
- services - Services.
- servicetypes - Service types.
- scripts - Application scripting additions.
- sound - Application sounds.
- templates - Templates
- wallpaper - Wallpapers.
- tmp - Temporary files (specific for both current host and current user)
- socket - UNIX Sockets (specific for both current host and current user)
KStandardDirs supports the following environment variables:
- KDEDIRS: This may set an additional number of directory prefixes to search for resources. The directories should be separated by ':'. The directories are searched in the order they are specified.
- KDEDIR: Used for backwards compatibility. As KDEDIRS but only a single directory may be specified. If KDEDIRS is set KDEDIR is ignored.
- KDEHOME: The directory where changes are saved to. This directory is used to search for resources first. If KDEHOME is not specified it defaults to "$HOME/.kde"
- KDEROOTHOME: Like KDEHOME, but used for the root user. If KDEROOTHOME is not set it defaults to the .kde directory in the home directory of root, usually "/root/.kde". Note that the setting of $HOME is ignored in this case.
- See also:
- KGlobalSettings
Definition at line 126 of file kstandarddirs.h.
Constructor & Destructor Documentation
|
KStandardDirs' constructor. It just initializes the caches. Definition at line 83 of file kstandarddirs.cpp. References addKDEDefaults(), QDict< QString >::setAutoDelete(), and QDict< QStringList >::setAutoDelete(). |
|
KStandardDirs' destructor.
Definition at line 93 of file kstandarddirs.cpp. |
Member Function Documentation
|
Adds another search dir to front of the
Definition at line 140 of file kstandarddirs.cpp. References QString::at(), QDict< QStringList >::clear(), QString::isNull(), and QString::length(). Referenced by addCustomized(), and addKDEDefaults(). |
|
Adds another search dir to front of the XDG_CONFIG_XXX list of prefixes. This prefix is only used for resources that start with "xdgconf-"
Definition at line 155 of file kstandarddirs.cpp. References QString::at(), QDict< QStringList >::clear(), QString::isNull(), and QString::length(). Referenced by addKDEDefaults(). |
|
Adds another search dir to front of the XDG_DATA_XXX list of prefixes. This prefix is only used for resources that start with "xdgdata-"
Definition at line 170 of file kstandarddirs.cpp. References QString::at(), QDict< QStringList >::clear(), QString::isNull(), and QString::length(). Referenced by addKDEDefaults(). |
|
Adds suffixes for types. You may add as many as you need, but it is advised that there is exactly one to make writing definite. All basic types ( kde_default) are added by addKDEDefaults(), but for those you can add more relative paths as well. The later a suffix is added, the higher its priority. Note, that the suffix should end with / but doesn't have to start with one (as prefixes should end with one). So adding a suffix for app_pics would look like KGlobal::dirs()->addResourceType("app_pics", "share/app/pics");
Definition at line 191 of file kstandarddirs.cpp. References QString::at(), QDict< QStringList >::find(), QDict< QStringList >::insert(), QString::isNull(), QString::length(), and QDict< QStringList >::remove(). Referenced by addKDEDefaults(). |
|
Adds absolute path at the end of the search path for particular types (for example in case of icons where the user specifies extra paths). You shouldn't need this function in 99% of all cases besides adding user-given paths.
Definition at line 213 of file kstandarddirs.cpp. References QString::at(), QDict< QStringList >::find(), QDict< QStringList >::insert(), QString::length(), and QDict< QStringList >::remove(). Referenced by addCustomized(), and addKDEDefaults(). |
|
Tries to find a resource in the following order:
Definition at line 233 of file kstandarddirs.cpp. References QString::at(), findResourceDir(), and QString::isNull(). Referenced by KLibLoader::findLibrary(), and locate(). |
|
Checks whether a resource is restricted as part of the KIOSK framework. When a resource is restricted it means that user- specific files in the resource are ignored. E.g. by restricting the "wallpaper" resource, only system-wide installed wallpapers will be found by this class. Wallpapers installed under the $KDEHOME directory will be ignored.
Definition at line 98 of file kstandarddirs.cpp. Referenced by KConfigINIBackEnd::parseConfigFiles(). |
|
Returns a number that identifies this version of the resource. When a change is made to the resource this number will change.
Definition at line 268 of file kstandarddirs.cpp. References QString::at(), and resourceDirs(). |
|
Tries to find all directories whose names consist of the specified type and a relative path. So would findDirs("apps", "Settings") return
Definition at line 294 of file kstandarddirs.cpp. References QDir::absPath(), QString::endsWith(), QDir::exists(), resourceDirs(), QDir::setPath(), and QString::startsWith(). |
|
Tries to find the directory the file is in. It works the same as findResource(), but it doesn't return the filename but the name of the directory. This way the application can access a couple of files that have been installed into the same directory without having to look for each file. findResourceDir("lib", "libkdecore.la") would return the path of the subdir libkdecore.la is found first in (e.g. /opt/kde/lib/)
Definition at line 328 of file kstandarddirs.cpp. References exists(), QString::isEmpty(), and resourceDirs(). Referenced by findResource(). |
|
Tries to find all resources with the specified type. The function will look into all specified directories and return all filenames in these directories.
Definition at line 565 of file kstandarddirs.cpp. Referenced by KLocale::allCountriesTwoAlpha(), KPalette::getPaletteList(), and KConfigINIBackEnd::parseConfigFiles(). |
|
Tries to find all resources with the specified type. The function will look into all specified directories and return all filenames (full and relative paths) in these directories.
Definition at line 514 of file kstandarddirs.cpp. References QString::findRev(), QString::isEmpty(), QString::left(), QString::length(), QString::mid(), resourceDirs(), and QString::startsWith(). |
|
Returns a QStringList list of pathnames in the system path.
Definition at line 714 of file kstandarddirs.cpp. References QString::find(), QString::fromLocal8Bit(), QDir::homeDirPath(), QString::isNull(), QString::length(), QString::local8Bit(), QString::mid(), and QString::replace(). Referenced by findAllExe(), and findExe(). |
|
Finds the executable in the system path. A valid executable must be a file and have its executable bit set.
Definition at line 758 of file kstandarddirs.cpp. References QString::arg(), QFileInfo::exists(), QString::fromLatin1(), QFileInfo::isExecutable(), QFileInfo::isFile(), QFileInfo::isSymLink(), QFileInfo::setFile(), QString::startsWith(), and systemPaths(). Referenced by KConfigBackEnd::checkConfigFilesWritable(). |
|
Finds all occurrences of an executable in the system path.
Definition at line 802 of file kstandarddirs.cpp. References QFileInfo::exists(), QFileInfo::isExecutable(), QFileInfo::isFile(), QFileInfo::setFile(), and systemPaths(). |
|
This function adds the defaults that are used by the current KDE version. It's a series of addResourceTypes() and addPrefix() calls. You normally wouldn't call this function because it's called for you from KGlobal. Definition at line 1027 of file kstandarddirs.cpp. References addPrefix(), addResourceDir(), addResourceType(), addXdgConfigPrefix(), addXdgDataPrefix(), QDir::homeDirPath(), QString::isEmpty(), kde_default(), QString::length(), and KShell::tildeExpand(). Referenced by KStandardDirs(). |
|
Reads customized entries out of the given config object and add them via addResourceDirs().
Definition at line 1180 of file kstandarddirs.cpp. References addPrefix(), addResourceDir(), QMap::begin(), QMap::end(), KConfig::entryMap(), KConfigBase::group(), KStdAccel::key(), QString::latin1(), QString::left(), QString::length(), QString::mid(), KConfigBase::readBoolEntry(), KConfigBase::readListEntry(), QDict< QStringList >::remove(), resourceDirs(), KConfigBase::setGroup(), and QStringList::split(). Referenced by KInstance::config(), KInstance::dirs(), and KConfig::KConfig(). |
|
This function is used internally by almost all other function as it serves and fills the directories cache.
Definition at line 623 of file kstandarddirs.cpp. References QDir::exists(), QDict< QStringList >::find(), QDict< QStringList >::insert(), realPath(), and QDir::setPath(). Referenced by addCustomized(), KIconLoader::addExtraDesktopThemes(), calcResourceHash(), findAllResources(), findDirs(), findResourceDir(), KIconTheme::KIconTheme(), KLocale::langLookup(), KIconTheme::list(), relativeLocation(), and saveLocation(). |
|
This function will return a list of all the types that KStandardDirs supports.
Definition at line 132 of file kstandarddirs.cpp. References QString::fromLatin1(). |
|
Finds a location to save files into for the given type in the user's home directory.
Definition at line 901 of file kstandarddirs.cpp. References QFile::encodeName(), QDict< QStringList >::find(), QDict< QString >::find(), QDict< QString >::insert(), QString::latin1(), localkdedir(), localxdgconfdir(), localxdgdatadir(), makeDir(), realPath(), QDict< QStringList >::remove(), and resourceDirs(). Referenced by KConfigBackEnd::changeFileName(), and locateLocal(). |
|
Converts an absolute path to a path relative to a certain resource. If "abs = locate(resource, rel)" then "rel = relativeLocation(resource, abs)" and vice versa.
Definition at line 957 of file kstandarddirs.cpp. References QString::findRev(), QString::left(), QString::mid(), realPath(), resourceDirs(), and QString::startsWith(). Referenced by KDesktopFile::isAuthorizedDesktopFile(), and KDesktopFile::locateLocal(). |
|
Recursively creates still-missing directories in the given path. The resulting permissions will depend on the current umask setting. permission = mode & ~umask.
Definition at line 979 of file kstandarddirs.cpp. References QString::at(), QFile::encodeName(), QString::find(), QString::length(), QString::mid(), and KIO::mkdir(). Referenced by KConfigINIBackEnd::parseConfigFiles(), saveLocation(), and KConfigINIBackEnd::sync(). |
|
This returns a default relative path for the standard KDE resource types. Below is a list of them so you get an idea of what this is all about.
Definition at line 852 of file kstandarddirs.cpp. Referenced by KIconLoader::addAppDir(), and addKDEDefaults(). |
|
Returns the toplevel directory in which KStandardDirs will store things. Most likely $HOME/.kde Don't use this function if you can use locateLocal
Definition at line 1241 of file kstandarddirs.cpp. Referenced by saveLocation(). |
|
Definition at line 1247 of file kstandarddirs.cpp. Referenced by saveLocation(). |
|
Definition at line 1253 of file kstandarddirs.cpp. Referenced by saveLocation(). |
|
Checks for existence and accessability. Faster than creating a QFileInfo first.
Definition at line 356 of file kstandarddirs.cpp. References QString::at(), QFile::encodeName(), and QString::length(). Referenced by KIconLoader::addExtraDesktopThemes(), findResourceDir(), KIconTheme::KIconTheme(), and KIconTheme::list(). |
|
Expands all symbolic links and resolves references to '/./', '/../' and extra '/' characters in The resulting path will have no symbolic link, '/./' or '/../' components.
Definition at line 575 of file kstandarddirs.cpp. References QFile::decodeName(), and QFile::encodeName(). Referenced by KMountPoint::currentMountPoints(), KMountPoint::possibleMountPoints(), relativeLocation(), resourceDirs(), and saveLocation(). |
The documentation for this class was generated from the following files: