---

KDesktopFile Class Reference

KDE Desktop File Management class. More...

#include <kdesktopfile.h>

Inheritance diagram for KDesktopFile:

List of all members.

Public Methods
	KDesktopFile (const QString &fileName, bool readOnly=false, const char *resType="apps")
virtual	~KDesktopFile ()
QString	readType () const
QString	readIcon () const
QString	readName () const
QString	readComment () const
QString	readGenericName () const
QString	readPath () const
QString	readDevice () const
QString	readURL () const
QStringList	readActions () const
void	setActionGroup (const QString &group)
bool	hasActionGroup (const QString &group) const
bool	hasLinkType () const
bool	hasApplicationType () const
bool	hasMimeTypeType () const
bool	hasDeviceType () const
bool	tryExec () const
QString	fileName () const
QString	resource () const
QString	readDocPath () const
QStringList	sortOrder () const
QString	filename () const
Static Public Methods
bool	isDesktopFile (const QString &path)
bool	isAuthorizedDesktopFile (const QString &path)
Protected Methods
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

KDE Desktop File Management class.

KDE Desktop File Management.

Author:

Pietro Iglio <iglio@kde.org>

Version:

Id:

kdesktopfile.h,v 1.30 2002/09/28 12:28:47 tjansen Exp

See also:

KConfigBase KConfig

Definition at line 36 of file kdesktopfile.h.

---

Constructor & Destructor Documentation

KDesktopFile::KDesktopFile (  const QString &    fileName, bool    readOnly = false, const char *    resType = "apps" )

Constructs a KDesktopFile object and make it either read-write or read-only. Parameters: fileName  The name or path of the desktop file. If it is not absolute, it will be located using the resource type resType. readOnly  Whether the object should be read-only. resType  Allows you to change what sort of resource to search for if fileName is not absolute. For instance, you might want to specify "config".

virtual KDesktopFile::~KDesktopFile (    )  [virtual]

Destructs the KDesktopFile object. Writes back any dirty configuration entries.

---

Member Function Documentation

QString KDesktopFile::filename (    )  const [inline]

Deprecated: Use See also: fileName() instead. Definition at line 218 of file kdesktopfile.h. References fileName().

QString KDesktopFile::fileName (    )

Returns the file name. Returns: The filename as passed to the constructor. Referenced by filename().

bool KDesktopFile::hasActionGroup (  const QString &    group )  const

Returns true if the action group exists, false otherwise Parameters: the  action group to test Returns: true if the action group exists

bool KDesktopFile::hasApplicationType (    )

Checks whether there is an entry "Type=Application". Returns: true if there is a "Type=Application" entry

bool KDesktopFile::hasDeviceType (    )

Checks whether there is an entry "Type=FSDev". Returns: true if there is a "Type=FSDev" entry

bool KDesktopFile::hasLinkType (    )

Checks whether there is a "Type=Link" entry. The link points to the "URL=" entry. Returns: true if there is a "Type=Link" entry

bool KDesktopFile::hasMimeTypeType (    )

Checks whether there is an entry "Type=MimeType". Returns: true if there is a "Type=MimeType" entry

bool KDesktopFile::isAuthorizedDesktopFile (  const QString &    path )  [static]

Checks whether the user is authorized to run this desktop file. By default users are authorized to run all desktop files but the KIOSK framework can be used to activate certain restrictions. See README.kiosk for more information. Parameters: path  the file to check Returns: true if the user is authorized to run the file Since: 3.1

bool KDesktopFile::isDesktopFile (  const QString &    path )  [static]

Checks whether this is really a desktop file. The check is performed looking at the file extension (the file is not opened). Currently, valid extensions are ".kdelnk" and ".desktop". Parameters: path  the path of the file to check Returns: true if the file appears to be a desktop file.

QStringList KDesktopFile::readActions (    )

Returns a list of the "Actions=" entries. Returns: the list of actions

QString KDesktopFile::readComment (    )

Returns the value of the "Comment=" entry. Returns: the comment or QString::null if not specified

QString KDesktopFile::readDevice (    )

Returns the value of the "Dev=" entry. Returns: the device or QString::null if not specified

QString KDesktopFile::readDocPath (    )

Returns the value of the "DocPath=" entry. Returns: The value of the "DocPath=" entry. Since: 3.1

QString KDesktopFile::readGenericName (    )

Returns the value of the "GenericName=" entry. Returns: the generic name or QString::null if not specified

QString KDesktopFile::readIcon (    )

Returns the value of the "Icon=" entry. Returns: the icon or QString::null if not specified

QString KDesktopFile::readName (    )

Returns the value of the "Name=" entry. Returns: the name or QString::null if not specified

QString KDesktopFile::readPath (    )

Returns the value of the "Path=" entry. Returns: the path or QString::null if not specified Deprecated:

QString KDesktopFile::readType (    )

Returns the value of the "Type=" entry. Returns: the type or QString::null if not specified

QString KDesktopFile::readURL (    )

Returns the value of the "URL=" entry. Returns: the URL or QString::null if not specified

QString KDesktopFile::resource (    )

Returns the resource. Returns: The resource type as passed to the constructor.

void KDesktopFile::setActionGroup (  const QString &    group )

Sets the desktop action group. Parameters: the  new action group

QStringList KDesktopFile::sortOrder (    )

Returns the entry of the "SortOrder=" entry. Returns: the value of the "SortOrder=" entry.

bool KDesktopFile::tryExec (    )

Checks whether the TryExec field contains a binary which is found on the local system. Returns: true if TryExec contains an existing binary

---

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

• kdesktopfile.h

---