kdecore Library API Documentation

KDesktopFile Class Reference

KDE Desktop File Management. KDE Desktop File Management class. More...

#include <kdesktopfile.h>

Inheritance diagram for KDesktopFile:

KConfig KConfigBase QObject 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
KDesktopFile * copyTo (const QString &file) const
KDE_DEPRECATED QString filename () const

Static Public Methods

bool isDesktopFile (const QString &path)
bool isAuthorizedDesktopFile (const QString &path)
QString locateLocal (const QString &path)

Protected Methods

virtual void virtual_hook (int id, void *data)

Detailed Description

KDE Desktop File Management. KDE Desktop File Management class.

Author:
Pietro Iglio <iglio@kde.org>
Version:
Id:
kdesktopfile.h,v 1.36 2003/09/19 22:51:47 hausmann Exp
See also:
KConfigBase KConfig

Definition at line 37 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".

Definition at line 39 of file kdesktopfile.cpp.

References KConfigBase::backEnd, KConfigBackEnd::changeFileName(), KConfig::reparseConfiguration(), KConfigBase::setDesktopGroup(), and KConfigBase::setReadOnly().

Referenced by copyTo().

KDesktopFile::~KDesktopFile   [virtual]
 

Destructs the KDesktopFile object.

Writes back any dirty configuration entries.

Definition at line 52 of file kdesktopfile.cpp.


Member Function Documentation

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.

Definition at line 101 of file kdesktopfile.cpp.

References QString::fromLatin1(), QString::length(), and QString::right().

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

Definition at line 113 of file kdesktopfile.cpp.

References KGlobal::dirs(), QString::isEmpty(), KStandardDirs::relativeLocation(), and QString::startsWith().

QString KDesktopFile::locateLocal const QString   path [static]
 

Returns the location where changes for the .desktop file path should be written to.

Since:
3.2

Definition at line 57 of file kdesktopfile.cpp.

References KGlobal::dirs(), QString::endsWith(), QString::findRev(), QString::mid(), KStandardDirs::relativeLocation(), and QString::startsWith().

QString KDesktopFile::readType  
 

Returns the value of the "Type=" entry.

Returns:
the type or QString::null if not specified

Definition at line 136 of file kdesktopfile.cpp.

References KConfigBase::readEntry().

QString KDesktopFile::readIcon  
 

Returns the value of the "Icon=" entry.

Returns:
the icon or QString::null if not specified

Definition at line 141 of file kdesktopfile.cpp.

References KConfigBase::readEntry().

QString KDesktopFile::readName  
 

Returns the value of the "Name=" entry.

Returns:
the name or QString::null if not specified

Definition at line 146 of file kdesktopfile.cpp.

References KConfigBase::readEntry().

QString KDesktopFile::readComment  
 

Returns the value of the "Comment=" entry.

Returns:
the comment or QString::null if not specified

Definition at line 151 of file kdesktopfile.cpp.

References KConfigBase::readEntry().

QString KDesktopFile::readGenericName  
 

Returns the value of the "GenericName=" entry.

Returns:
the generic name or QString::null if not specified

Definition at line 156 of file kdesktopfile.cpp.

References KConfigBase::readEntry().

QString KDesktopFile::readPath  
 

Returns the value of the "Path=" entry.

Returns:
the path or QString::null if not specified

Definition at line 161 of file kdesktopfile.cpp.

References KConfigBase::readPathEntry().

QString KDesktopFile::readDevice  
 

Returns the value of the "Dev=" entry.

Returns:
the device or QString::null if not specified

Definition at line 166 of file kdesktopfile.cpp.

References KConfigBase::readEntry().

Referenced by readURL().

QString KDesktopFile::readURL  
 

Returns the value of the "URL=" entry.

Returns:
the URL or QString::null if not specified

Definition at line 171 of file kdesktopfile.cpp.

References QValueList< Ptr >::begin(), QValueList< Ptr >::end(), hasDeviceType(), QString::isEmpty(), KMountPoint::mountedFrom(), KMountPoint::mountPoint(), KMountPoint::possibleMountPoints(), readDevice(), KConfigBase::readPathEntry(), KURL::setPath(), and KURL::url().

QStringList KDesktopFile::readActions  
 

Returns a list of the "Actions=" entries.

Returns:
the list of actions

Definition at line 202 of file kdesktopfile.cpp.

References KConfigBase::readListEntry().

void KDesktopFile::setActionGroup const QString   group
 

Sets the desktop action group.

Parameters:
group  the new action group

Definition at line 207 of file kdesktopfile.cpp.

References QString::fromLatin1(), and KConfigBase::setGroup().

bool KDesktopFile::hasActionGroup const QString   group const
 

Returns true if the action group exists, false otherwise.

Parameters:
group  the action group to test
Returns:
true if the action group exists

Definition at line 212 of file kdesktopfile.cpp.

References QString::fromLatin1(), and KConfigBase::hasGroup().

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

Definition at line 217 of file kdesktopfile.cpp.

References QString::fromLatin1(), and KConfigBase::readEntry().

bool KDesktopFile::hasApplicationType  
 

Checks whether there is an entry "Type=Application".

Returns:
true if there is a "Type=Application" entry

Definition at line 222 of file kdesktopfile.cpp.

References QString::fromLatin1(), and KConfigBase::readEntry().

bool KDesktopFile::hasMimeTypeType  
 

Checks whether there is an entry "Type=MimeType".

Returns:
true if there is a "Type=MimeType" entry

Definition at line 227 of file kdesktopfile.cpp.

References QString::fromLatin1(), and KConfigBase::readEntry().

bool KDesktopFile::hasDeviceType  
 

Checks whether there is an entry "Type=FSDev".

Returns:
true if there is a "Type=FSDev" entry

Definition at line 232 of file kdesktopfile.cpp.

References QString::fromLatin1(), and KConfigBase::readEntry().

Referenced by readURL().

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

Definition at line 238 of file kdesktopfile.cpp.

References QFile::decodeName(), QFile::encodeName(), QString::isEmpty(), KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readListEntry(), KConfigBase::readPathEntry(), and QStringList::split().

QString KDesktopFile::fileName  
 

Returns the file name.

Returns:
The filename as passed to the constructor.

Definition at line 299 of file kdesktopfile.cpp.

References KConfigBase::backEnd, and KConfigBackEnd::fileName().

Referenced by filename().

QString KDesktopFile::resource  
 

Returns the resource.

Returns:
The resource type as passed to the constructor.

Definition at line 305 of file kdesktopfile.cpp.

References KConfigBase::backEnd, and KConfigBackEnd::resource().

QString KDesktopFile::readDocPath  
 

Returns the value of the "DocPath=" entry.

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

Definition at line 316 of file kdesktopfile.cpp.

References KConfigBase::readPathEntry().

QStringList KDesktopFile::sortOrder  
 

Returns the entry of the "SortOrder=" entry.

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

Definition at line 308 of file kdesktopfile.cpp.

References KConfigBase::readListEntry().

KDesktopFile * KDesktopFile::copyTo const QString   file const
 

Copies all entries from this config object to a new KDesktopFile object that will save itself to file.

Actual saving to file happens when the returned object is destructed or when sync() is called upon it.

Parameters:
file  the new KDesktopFile object it will save itself to.
Since:
3.2

Definition at line 321 of file kdesktopfile.cpp.

References KConfig::copyTo(), KDesktopFile(), and KConfigBase::setDesktopGroup().

KDE_DEPRECATED QString KDesktopFile::filename   const [inline]
 

Deprecated:
Use
See also:
fileName() instead.

Definition at line 236 of file kdesktopfile.h.

References fileName().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdecore Library Version 3.2.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 4 12:33:55 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003