KStandardDirs Class Reference

#include <kstandarddirs.h>

Public Types
enum	SearchOption { NoSearchOptions = 0, Recursive = 1, NoDuplicates = 2, IgnoreExecBit = 4 }

Public Member Functions
	KStandardDirs ()
virtual	~KStandardDirs ()
bool	addCustomized (KConfig *config)
void	addPrefix (const QString &dir)
bool	addResourceDir (const char *type, const QString &absdir, bool priority=true)
bool	addResourceType (const char *type, const QString &relativename, bool priority=true)
bool	addResourceType (const char *type, const char *basetype, const QString &relativename, bool priority=true)
bool	addResourceType (const char *type, const char *basetype, const char *relativename, bool priority=true)
void	addXdgConfigPrefix (const QString &dir)
void	addXdgDataPrefix (const QString &dir)
QStringList	allTypes () const
quint32	calcResourceHash (const char *type, const QString &filename, SearchOptions options=NoSearchOptions) const
QStringList	findAllResources (const char *type, const QString &filter=QString(), SearchOptions options=NoSearchOptions) const
QStringList	findAllResources (const char *type, const QString &filter, SearchOptions options, QStringList &relPaths) const
QStringList	findDirs (const char *type, const QString &reldir) const
QString	findResource (const char *type, const QString &filename) const
QString	findResourceDir (const char *type, const QString &filename) const
bool	isRestrictedResource (const char *type, const QString &relPath=QString()) const
QString	kfsstnd_prefixes ()
QString	kfsstnd_xdg_conf_prefixes ()
QString	kfsstnd_xdg_data_prefixes ()
QString	localkdedir () const
QString	localxdgconfdir () const
QString	localxdgdatadir () const
QString	relativeLocation (const char *type, const QString &absPath)
QStringList	resourceDirs (const char *type) const
QString	saveLocation (const char *type, const QString &suffix=QString(), bool create=true) const

Static Public Member Functions
static bool	checkAccess (const QString &pathname, int mode)
static bool	exists (const QString &fullPath)
static int	findAllExe (QStringList &list, const QString &appname, const QString &pathstr=QString(), SearchOptions options=NoSearchOptions)
static QString	findExe (const QString &appname, const QString &pathstr=QString(), SearchOptions options=NoSearchOptions)
static QString	installPath (const char *type)
static QString	kde_default (const char *type)
static QString	locate (const char *type, const QString &filename, const KComponentData &cData=KGlobal::mainComponent())
static QString	locateLocal (const char *type, const QString &filename, const KComponentData &cData=KGlobal::mainComponent())
static QString	locateLocal (const char *type, const QString &filename, bool createDir, const KComponentData &cData=KGlobal::mainComponent())
static bool	makeDir (const QString &dir, int mode=0755)
static QString	realFilePath (const QString &filename)
static QString	realPath (const QString &dirname)
static QStringList	systemPaths (const QString &pstr=QString())

Detailed Description

Site-independent access to standard KDE directories.

Author

Stephan Kulow coolo.nosp@m.@kde.nosp@m..org and Sirtaj Singh Kang taj@k.nosp@m.de.o.nosp@m.rg

This is one of the most central classes in kdelibs: It knows where KDE-related files reside on the user's hard disk. It's meant to be the only one that knows – so applications and the end user don't have to.

Applications should always refer to a file with a resource type. The application should leave it up to e.g. KStandardDirs::findResource("apps", "Home.desktop") to return the desired path /opt/kde/share/applnk/Home.desktop or ::locate("data", "kgame/background.jpg") to return /opt/kde/share/apps/kgame/background.jpg

There are several toplevel prefixes under which files can be located. One of them is the kdelibs install location, one is the application install location, and one is $KDEHOME. Under these toplevel prefixes there are several well-defined suffixes where specific resource types can be found. For example, for the resource type "html" the suffixes could be share/doc/HTML and share/doc/kde/HTML. The search algorithm tries to locate the file under each prefix-suffix combination.

It is 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 $KDEHOME directory, for example for icons.

Standard resources that kdelibs allocates are:

• apps - Applications menu (.desktop files).
• autostart - Autostart directories (both XDG and kde-specific)
• cache - Cached information (e.g. favicons, web-pages)
• cgi - CGIs to run from kdehelp.
• config - Configuration files.
• data - Where applications store data.
• emoticons - Emoticons themes
• exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
• html - HTML documentation.
• icon - Icons, see KIconLoader.
• kcfg - KConfigXT config files.
• lib - Libraries.
• locale - Translation files for KLocale.
• mime - Mime types defined by KDE-specific .desktop files.
• module - Module (dynamically loaded library).
• qtplugins - Qt plugins (dynamically loaded objects for Qt)
• services - Services.
• servicetypes - Service types.
• sound - Application sounds.
• templates - Templates for the "Create new file" functionality.
• wallpaper - Wallpapers.
• tmp - Temporary files (specific for both current host and current user)
• socket - UNIX Sockets (specific for both current host and current user)
• xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
• xdgdata-apps - Freedesktop.org standard location for application desktop files.
• xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
• xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
• xdgdata-icon - Freedesktop.org standard location for icons.
• xdgdata-pixmap - Gnome-compatibility location for pixmaps.

A type that is added by the class KApplication if you use it, is appdata. This one makes the use of the type data a bit easier as it appends the name of the application. So while you had to ::locate("data", "appname/filename") so you can also write ::locate("appdata", "filename") if your KApplication instance is called "appname" (as set via KApplication's constructor or KAboutData, if you use the global KStandardDirs object KGlobal::dirs()). Please note though that you cannot use the "appdata" type if you intend to use it in an applet for Kicker because 'appname' would be "Kicker" instead of the applet's name. Therefore, for applets, you've got to work around this by using ::locate("data", "appletname/filename").

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.
• 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

On The Usage Of 'locate' and 'locateLocal'

Typical KDE applications use resource files in one out of three ways:

1) A resource file is read but is never written. A system default is supplied but the user can override this default in his local .kde directory:

// Code example
myFile = KStandardDirs::locate("appdata", "groups.lst");
myData =  myReadGroups(myFile); // myFile may be null

2) A resource file is read and written. If the user has no local version of the file the system default is used. The resource file is always written to the users local .kde directory.

// Code example
myFile = KStandardDirs::locate("appdata", "groups.lst")
myData =  myReadGroups(myFile);
...
doSomething(myData);
...
myFile = KStandardDirs::locateLocal("appdata", "groups.lst");
myWriteGroups(myFile, myData);

3) A resource file is read and written. No system default is used if the user has no local version of the file. The resource file is always written to the users local .kde directory.

// Code example
myFile = KStandardDirs::locateLocal("appdata", "groups.lst");
myData =  myReadGroups(myFile);
...
doSomething(myData);
...
myFile = KStandardDirs::locateLocal("appdata", "groups.lst");
myWriteGroups(myFile, myData);

Definition at line 171 of file kstandarddirs.h.

Member Enumeration Documentation

enum KStandardDirs::SearchOption

Enumerator
NoSearchOptions
Recursive
NoDuplicates
IgnoreExecBit

Definition at line 190 of file kstandarddirs.h.

Constructor & Destructor Documentation

KStandardDirs::KStandardDirs

(

)

KStandardDirs' constructor.

It just initializes the caches. Note that you should normally not call this, but use KGlobal::dirs() instead, in order to reuse the same KStandardDirs object as much as possible.

Creating other KStandardDirs instances can be useful in other threads.

Thread safety note: using a shared KStandardDirs instance (such as KGlobal::dirs()) in multiple threads is thread-safe if you only call the readonly "lookup" methods (findExe, resourceDirs, findDirs, findResourceDir, findAllResources, saveLocation, relativeLocation). The methods that modify the object (all those starting with "add", basically all non-const methods) are obviously not thread-safe; set things up before creating threads.

Definition at line 243 of file kstandarddirs.cpp.

KStandardDirs::~KStandardDirs ( )

virtual

KStandardDirs' destructor.

Definition at line 249 of file kstandarddirs.cpp.

Member Function Documentation

bool KStandardDirs::addCustomized

(

KConfig *

config

)

Reads customized entries out of the given config object and add them via addResourceDirs().

Parameters

config

The object the entries are read from. This should contain global config files

Returns

true if new config paths have been added from config.

Definition at line 1939 of file kstandarddirs.cpp.

void KStandardDirs::addPrefix

(

const QString &

dir

)

Adds another search dir to front of the fsstnd list.

• When compiling kdelibs, the prefix is added to this.
• KDEDIRS is taken into account
• Additional dirs may be loaded from kdeglobals.

Parameters

dir	The directory to append relative paths to.

Definition at line 317 of file kstandarddirs.cpp.

bool KStandardDirs::addResourceDir	(	const char *	type,
		const QString &	absdir,
		bool	priority = true
	)

Adds absolute path at the beginning 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.

Parameters

type	Specifies a short descriptive string to access files of this type.
absdir	Points to directory where to look for this specific type. Non-existent directories may be saved but pruned.
priority	if true, the directory is added before any other, otherwise after

Returns

true if successful, false otherwise.

Definition at line 432 of file kstandarddirs.cpp.

bool KStandardDirs::addResourceType	(	const char *	type,
		const QString &	relativename,
		bool	priority = true
	)

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 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", "data" ,"app/pics");

Parameters

type	Specifies a short descriptive string to access files of this type.
relativename	Specifies a directory relative to the root of the KFSSTND.
priority	if true, the directory is added before any other, otherwise after

Returns

true if successful, false otherwise.

Deprecated:

, use addResourceType(type, 0, relativename, priority)

Definition at line 393 of file kstandarddirs.cpp.

bool KStandardDirs::addResourceType	(	const char *	type,
		const char *	basetype,
		const QString &	relativename,
		bool	priority = true
	)

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 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", "data", "app/pics");

Parameters

type	Specifies a short descriptive string to access files of this type.
basetype	Specifies an already known type, or 0 if none
relativename	Specifies a directory relative to the basetype
priority	if true, the directory is added before any other, otherwise after

Returns

true if successful, false otherwise.

Definition at line 401 of file kstandarddirs.cpp.

bool KStandardDirs::addResourceType ( const char *  type, const char *  basetype, const char *  relativename, bool  priority = true  )

inline

- just to avoid unwanted overload

Definition at line 283 of file kstandarddirs.h.

void KStandardDirs::addXdgConfigPrefix

(

const QString &

dir

)

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-"

Parameters

dir	The directory to append relative paths to.

Definition at line 337 of file kstandarddirs.cpp.

void KStandardDirs::addXdgDataPrefix

(

const QString &

dir

)

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-"

Parameters

dir	The directory to append relative paths to.

Definition at line 357 of file kstandarddirs.cpp.

QStringList KStandardDirs::allTypes

(

)

const

This function will return a list of all the types that KStandardDirs supports.

Returns

All types that KDE supports

Definition at line 281 of file kstandarddirs.cpp.

quint32 KStandardDirs::calcResourceHash	(	const char *	type,
		const QString &	filename,
		SearchOptions	options = NoSearchOptions
	)		const

Returns a number that identifies this version of the resource.

When a change is made to the resource this number will change.

Parameters

type	The type of the wanted resource
filename	A relative filename of the resource.
options	If the flags includes Recursive, all resources are taken into account otherwise only the one returned by findResource().

Returns

A number identifying the current version of the resource.

Definition at line 499 of file kstandarddirs.cpp.

bool KStandardDirs::checkAccess ( const QString &  pathname, int  mode  )

static

Check, if a file may be accessed in a given mode.

This is a wrapper around the access() system call. checkAccess() calls access() with the given parameters. If this is OK, checkAccess() returns true. If not, and W_OK is part of mode, it is checked if there is write access to the directory. If yes, checkAccess() returns true. In all other cases checkAccess() returns false.

Other than access() this function EXPLICITLY ignores non-existent files if checking for write access.

Parameters

pathname	The full path of the file you want to test
mode	The access mode, as in the access() system call.

Returns

Whether the access is allowed, true = Access allowed

Definition at line 2114 of file kstandarddirs.cpp.

bool KStandardDirs::exists ( const QString &  fullPath )

static

Checks for existence and accessability of a file or directory.

Faster than creating a QFileInfo first.

Parameters

fullPath

the path to check. IMPORTANT: must end with a slash if expected to be a directory (and no slash for a file, obviously).

Returns

true if the directory exists, false otherwise

Definition at line 587 of file kstandarddirs.cpp.

int KStandardDirs::findAllExe ( QStringList &  list, const QString &  appname, const QString &  pathstr = QString(), SearchOptions  options = NoSearchOptions  )

static

Finds all occurrences of an executable in the system path.

Parameters

list	will be filled with the pathnames of all the executables found. Will be empty if the executable was not found.
appname	the name of the executable for which to search.
pathstr	the path list which will be searched. If this is 0 (default), the $PATH environment variable will be searched.
options	if the flags passed include IgnoreExecBit the path returned may not have the executable bit set.

Returns

The number of executables found, 0 if none were found.

See also

findExe()

Definition at line 1397 of file kstandarddirs.cpp.

QStringList KStandardDirs::findAllResources	(	const char *	type,
		const QString &	filter = QString(),
		SearchOptions	options = NoSearchOptions
	)		const

Tries to find all resources with the specified type.

The function will look into all specified directories and return all filenames in these directories.

The "most local" files are returned before the "more global" files.

Parameters

type	The type of resource to locate directories for.
filter	Only accept filenames that fit to filter. The filter may consist of an optional directory and a QRegExp wildcard expression. E.g. "images\*.jpg". Use QString() if you do not want a filter.
options	if the flags passed include Recursive, subdirectories will also be search; if NoDuplicates is passed then only entries with unique filenames will be returned eliminating duplicates.

Returns

List of all the files whose filename matches the specified filter.

Definition at line 900 of file kstandarddirs.cpp.

QStringList KStandardDirs::findAllResources	(	const char *	type,
		const QString &	filter,
		SearchOptions	options,
		QStringList &	relPaths
	)		const

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.

The "most local" files are returned before the "more global" files.

Parameters

type	The type of resource to locate directories for. Can be icon, lib, pixmap, .... To get a complete list, call kde4-config --types
filter	Only accept filenames that fit to filter. The filter may consist of an optional directory and a QRegExp wildcard expression. E.g. "images\*.jpg". Use QString() if you do not want a filter.
options	if the flags passed include Recursive, subdirectories will also be search; if NoDuplicates is passed then only entries with unique filenames will be returned eliminating duplicates.
relPaths	The list to store the relative paths into These can be used later to ::locate() the file

Returns

List of all the files whose filename matches the specified filter.

Definition at line 848 of file kstandarddirs.cpp.

QStringList KStandardDirs::findDirs	(	const char *	type,
		const QString &	reldir
	)		const

Tries to find all directories whose names consist of the specified type and a relative path.

So findDirs("apps", "Settings") would return

• /home/joe/.kde/share/applnk/Settings/
• /opt/kde/share/applnk/Settings/

(from the most local to the most global)

Note that it appends / to the end of the directories, so you can use this right away as directory names.

Parameters

type	The type of the base directory.
reldir	Relative directory.

Returns

A list of matching directories, or an empty list if the resource specified is not found.

Definition at line 523 of file kstandarddirs.cpp.

QString KStandardDirs::findExe ( const QString &  appname, const QString &  pathstr = QString(), SearchOptions  options = NoSearchOptions  )

static

Finds the executable in the system path.

A valid executable must be a file and have its executable bit set.

Parameters

appname	The name of the executable file for which to search. if this contains a path separator, it will be resolved according to the current working directory (shell-like behaviour).
pathstr	The path which will be searched. If this is null (default), the $PATH environment variable will be searched.
options	if the flags passed include IgnoreExecBit the path returned may not have the executable bit set.

Returns

The path of the executable. If it was not found, it will return QString().

See also

findAllExe()

Definition at line 1328 of file kstandarddirs.cpp.

QString KStandardDirs::findResource	(	const char *	type,
		const QString &	filename
	)		const

Tries to find a resource in the following order:

• All PREFIX/<relativename> paths (most recent first).
• All absolute paths (most recent first).

The filename should be a filename relative to the base dir for resources. So is a way to get the path to libkdecore.la to findResource("lib", "libkdecore.la"). KStandardDirs will then look into the subdir lib of all elements of all prefixes ($KDEDIRS) for a file libkdecore.la and return the path to the first one it finds (e.g. /opt/kde/lib/libkdecore.la). You can use the program kde4-config to list all resource types:

$ kde4-config --types

Example:

QString iconfilename=KGlobal::dirs()->findResource("icon",QString("oxygen/22x22/apps/ktip.png"));

Parameters

type	The type of the wanted resource
filename	A relative filename of the resource.

Returns

A full path to the filename specified in the second argument, or QString() if not found.

Definition at line 458 of file kstandarddirs.cpp.

QString KStandardDirs::findResourceDir	(	const char *	type,
		const QString &	filename
	)		const

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/)

Parameters

type	The type of the wanted resource
filename	A relative filename of the resource.

Returns

The directory where the file specified in the second argument is located, or QString() if the type of resource specified is unknown or the resource cannot be found.

Definition at line 553 of file kstandarddirs.cpp.

QString KStandardDirs::installPath ( const char *  type )

static

Returns

the path where type was installed to by kdelibs. This is an absolute path and only one out of many search paths

Definition at line 25 of file kstandarddirs_unix.cpp.

bool KStandardDirs::isRestrictedResource	(	const char *	type,
		const QString &	relPath = QString()
	)		const

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.

Parameters

type	The type of the resource to check
relPath	A relative path in the resource.

Returns

True if the resource is restricted.

Definition at line 254 of file kstandarddirs.cpp.

QString KStandardDirs::kde_default ( const char *  type )

static

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.

• data - share/apps
• html - share/doc/HTML
• icon - share/icon
• config - share/config
• pixmap - share/pixmaps
• apps - share/applnk
• sound - share/sounds
• locale - share/locale
• services - share/kde4/services
• servicetypes - share/kde4/servicetypes
• mime - share/mimelnk
• cgi - cgi-bin
• wallpaper - share/wallpapers
• templates - share/templates
• exe - bin
• lib - lib[suffix]
• module - lib[suffix]/kde4
• qtplugins - lib[suffix]/kde4/plugins
• kcfg - share/config.kcfg
• emoticons - share/emoticons
• xdgdata-apps - applications
• xdgdata-icon - icons
• xdgdata-pixmap - pixmaps
• xdgdata-dirs - desktop-directories
• xdgdata-mime - mime
• xdgconf-menu - menus

Returns

Static default for the specified resource. You should probably be using locate() or locateLocal() instead.

See also

locate()

locateLocal()

Definition at line 1472 of file kstandarddirs.cpp.

QString KStandardDirs::kfsstnd_prefixes

(

)

(for use by sycoca only)

Definition at line 377 of file kstandarddirs.cpp.

QString KStandardDirs::kfsstnd_xdg_conf_prefixes

(

)

(for use by sycoca only)

Definition at line 382 of file kstandarddirs.cpp.

QString KStandardDirs::kfsstnd_xdg_data_prefixes

(

)

(for use by sycoca only)

Definition at line 387 of file kstandarddirs.cpp.

QString KStandardDirs::localkdedir

(

)

const

Returns the toplevel directory in which KStandardDirs will store things.

Most likely $HOME/.kde. Don't use this function if you can use locateLocal()

Returns

the toplevel directory

Definition at line 2065 of file kstandarddirs.cpp.

QString KStandardDirs::localxdgconfdir

(

)

const

Returns

$XDG_CONFIG_HOME See also http://www.freedesktop.org/standards/basedir/draft/basedir-spec/basedir-spec.html

Definition at line 2077 of file kstandarddirs.cpp.

QString KStandardDirs::localxdgdatadir

(

)

const

Returns

$XDG_DATA_HOME See also http://www.freedesktop.org/standards/basedir/draft/basedir-spec/basedir-spec.html

Definition at line 2071 of file kstandarddirs.cpp.

QString KStandardDirs::locate ( const char *  type, const QString &  filename, const KComponentData &  cData = KGlobal::mainComponent()  )

static

This function is just for convenience.

It simply calls instance->dirs()->findResource(type, filename).

Parameters

type	The type of the wanted resource, see KStandardDirs
filename	A relative filename of the resource
cData	The KComponentData object

Returns

A full path to the filename specified in the second argument, or QString() if not found

Definition at line 2085 of file kstandarddirs.cpp.

QString KStandardDirs::locateLocal ( const char *  type, const QString &  filename, const KComponentData &  cData = KGlobal::mainComponent()  )

static

This function is much like locate.

However it returns a filename suitable for writing to. No check is made if the specified filename actually exists. Missing directories are created. If filename is only a directory, without a specific file, filename must have a trailing slash.

Parameters

type	The type of the wanted resource, see KStandardDirs
filename	A relative filename of the resource
cData	The KComponentData object

Returns

A full path to the filename specified in the second argument, or QString() if not found

Definition at line 2091 of file kstandarddirs.cpp.

QString KStandardDirs::locateLocal ( const char *  type, const QString &  filename, bool  createDir, const KComponentData &  cData = KGlobal::mainComponent()  )

static

This function is much like locate.

No check is made if the specified filename actually exists. Missing directories are created if createDir is true. If filename is only a directory, without a specific file, filename must have a trailing slash.

Parameters

type	The type of the wanted resource, see KStandardDirs
filename	A relative filename of the resource
createDir	If true, missing directories are created, if false, no directory is created
cData	The KComponentData object

Returns

A full path to the filename specified in the second argument, or QString() if not found

Definition at line 2097 of file kstandarddirs.cpp.

bool KStandardDirs::makeDir ( const QString &  dir, int  mode = 0755  )

static

Recursively creates still-missing directories in the given path.

The resulting permissions will depend on the current umask setting. permission = mode & ~umask.

Parameters

dir	Absolute path of the directory to be made.
mode	Directory permissions.

Returns

true if successful, false otherwise

Definition at line 1571 of file kstandarddirs.cpp.

QString KStandardDirs::realFilePath ( const QString &  filename )

static

Expands all symbolic links and resolves references to '/.

/', '/../' and extra '/' characters in filename and returns the canonicalized absolute pathname. The resulting path will have no symbolic link, '/./' or '/../' components.

Definition at line 973 of file kstandarddirs.cpp.

QString KStandardDirs::realPath ( const QString &  dirname )

static

Expands all symbolic links and resolves references to '/.

/', '/../' and extra '/' characters in dirname and returns the canonicalized absolute pathname. The resulting path will have no symbolic link, '/./' or '/../' components.

Definition at line 914 of file kstandarddirs.cpp.

QString KStandardDirs::relativeLocation	(	const char *	type,
		const QString &	absPath
	)

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.

Parameters

type	The type of resource.
absPath	An absolute path to make relative.

Returns

A relative path relative to resource type that will find absPath. If no such relative path exists, absPath will be returned unchanged.

Definition at line 1551 of file kstandarddirs.cpp.

QStringList KStandardDirs::resourceDirs

(

const char *

type

)

const

This function is used internally by almost all other function as it serves and fills the directories cache.

Parameters

type	The type of resource

Returns

The list of possible directories for the specified type. The function updates the cache if possible. If the resource type specified is unknown, it will return an empty list. Note, that the directories are assured to exist beside the save location, which may not exist, but is returned anyway.

Definition at line 1069 of file kstandarddirs.cpp.

QString KStandardDirs::saveLocation	(	const char *	type,
		const QString &	suffix = QString(),
		bool	create = true
	)		const

Finds a location to save files into for the given type in the user's home directory.

Parameters

type	The type of location to return.
suffix	A subdirectory name. Makes it easier for you to create subdirectories. You can't pass filenames here, you have to pass directory names only and add possible filename in that directory yourself. A directory name always has a trailing slash ('/').
create	If set, saveLocation() will create the directories needed (including those given by suffix).

Returns

A path where resources of the specified type should be saved, or QString() if the resource type is unknown.

Definition at line 1478 of file kstandarddirs.cpp.

QStringList KStandardDirs::systemPaths ( const QString &  pstr = QString() )

static

Returns a QStringList list of pathnames in the system path.

Parameters

pstr	The path which will be searched. If this is null (default), the $PATH environment variable will be searched.

Returns

a QStringList list of pathnames in the system path.

Definition at line 1235 of file kstandarddirs.cpp.

---

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

• kstandarddirs.h
• kstandarddirs.cpp
• kstandarddirs_unix.cpp
• kstandarddirs_win.cpp