• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KDesktopFile Class Reference

KDE Desktop File Management. More...

#include <KDesktopFile>

Inheritance diagram for KDesktopFile:
KConfig KConfigBase

List of all members.

Public Member Functions

const KConfigGroup actionGroup (const QString &group) const
KConfigGroup actionGroup (const QString &group)
KDesktopFile * copyTo (const QString &file) const
KConfigGroup desktopGroup () const
QString fileName () const
bool hasActionGroup (const QString &group) const
bool hasApplicationType () const
bool hasDeviceType () const
bool hasLinkType () const
bool hasMimeTypeType () const
 KDesktopFile (const QString &fileName)
 KDesktopFile (const char *resourceType, const QString &fileName)
bool noDisplay () const
QStringList readActions () const
QString readComment () const
QString readDevice () const
QString readDocPath () const
QString readGenericName () const
QString readIcon () const
QString readName () const
QString readPath () const
QString readType () const
QString readUrl () const
const char * resource () const
QStringList sortOrder () const
bool tryExec () const
virtual ~KDesktopFile ()

Static Public Member Functions

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

Detailed Description

KDE Desktop File Management.

This class implements KDE's support for the freedesktop.org Desktop Entry Spec.

Author:
Pietro Iglio <iglio@kde.org>
See also:
KConfigBase KConfig
Desktop Entry Spec

Definition at line 38 of file kdesktopfile.h.


Constructor & Destructor Documentation

KDesktopFile::KDesktopFile ( const char *  resourceType,
const QString &  fileName 
) [explicit]

Constructs a KDesktopFile object.

See KStandardDirs for more information on resources.

Parameters:
resourceType Allows you to change what sort of resource to search for if fileName is not absolute. For instance, you might want to specify "config".
fileName The name or path of the desktop file. If it is not absolute, it will be located using the resource type resType.

Definition at line 54 of file kdesktopfile.cpp.

KDesktopFile::KDesktopFile ( const QString &  fileName  )  [explicit]

Constructs a KDesktopFile object.

See KStandardDirs for more information on resources.

Parameters:
fileName The name or path of the desktop file. If it is not absolute, it will be located using the resource type "apps"

Definition at line 63 of file kdesktopfile.cpp.

KDesktopFile::~KDesktopFile (  )  [virtual]

Destructs the KDesktopFile object.

Writes back any dirty configuration entries.

Definition at line 73 of file kdesktopfile.cpp.


Member Function Documentation

const KConfigGroup KDesktopFile::actionGroup ( const QString &  group  )  const

Definition at line 254 of file kdesktopfile.cpp.

KConfigGroup KDesktopFile::actionGroup ( const QString &  group  ) 

Sets the desktop action group.

Parameters:
group the new action group

Definition at line 249 of file kdesktopfile.cpp.

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.

Definition at line 374 of file kdesktopfile.cpp.

KConfigGroup KDesktopFile::desktopGroup (  )  const

Definition at line 77 of file kdesktopfile.cpp.

QString KDesktopFile::fileName (  )  const

Definition at line 388 of file kdesktopfile.cpp.

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 259 of file kdesktopfile.cpp.

bool KDesktopFile::hasApplicationType (  )  const

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

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

Definition at line 269 of file kdesktopfile.cpp.

bool KDesktopFile::hasDeviceType (  )  const

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

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

Definition at line 279 of file kdesktopfile.cpp.

bool KDesktopFile::hasLinkType (  )  const

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 264 of file kdesktopfile.cpp.

bool KDesktopFile::hasMimeTypeType (  )  const

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

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

Definition at line 274 of file kdesktopfile.cpp.

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.

Note: Since KDE 4.3, there are more restrictions on authorized desktop files to prevent users from inadvertently running trojan desktop files. Your application launchers should have the executable bit set to prevent issues. To see if a restriction is due to KIOSK, see KAuthorized.

Parameters:
path the file to check
Returns:
true if the user is authorized to run the file

Definition at line 141 of file kdesktopfile.cpp.

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, the only valid extension is ".desktop".

Parameters:
path the path of the file to check
Returns:
true if the file appears to be a desktop file.

Definition at line 135 of file kdesktopfile.cpp.

QString KDesktopFile::locateLocal ( const QString &  path  )  [static]

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

Definition at line 83 of file kdesktopfile.cpp.

bool KDesktopFile::noDisplay (  )  const

Whether the entry should be suppressed in menus.

This handles the NoDisplay key, but also OnlyShowIn / NotShowIn.

Returns:
true to suppress this service
Since:
4.1

Definition at line 393 of file kdesktopfile.cpp.

QStringList KDesktopFile::readActions (  )  const

Returns a list of the "Actions=" entries.

Returns:
the list of actions

Definition at line 243 of file kdesktopfile.cpp.

QString KDesktopFile::readComment (  )  const

Returns the value of the "Comment=" entry.

Returns:
the comment or QString() if not specified

Definition at line 200 of file kdesktopfile.cpp.

QString KDesktopFile::readDevice (  )  const

Returns the value of the "Dev=" entry.

Returns:
the device or QString() if not specified

Definition at line 220 of file kdesktopfile.cpp.

QString KDesktopFile::readDocPath (  )  const

Returns the value of the "X-DocPath=" Or "DocPath=" entry.

Returns:
The value of the "X-DocPath=" Or "DocPath=" entry.

Definition at line 365 of file kdesktopfile.cpp.

QString KDesktopFile::readGenericName (  )  const

Returns the value of the "GenericName=" entry.

Returns:
the generic name or QString() if not specified

Definition at line 206 of file kdesktopfile.cpp.

QString KDesktopFile::readIcon (  )  const

Returns the value of the "Icon=" entry.

Returns:
the icon or QString() if not specified

Definition at line 188 of file kdesktopfile.cpp.

QString KDesktopFile::readName (  )  const

Returns the value of the "Name=" entry.

Returns:
the name or QString() if not specified

Definition at line 194 of file kdesktopfile.cpp.

QString KDesktopFile::readPath (  )  const

Returns the value of the "Path=" entry.

Returns:
the path or QString() if not specified

Definition at line 212 of file kdesktopfile.cpp.

QString KDesktopFile::readType (  )  const

Returns the value of the "Type=" entry.

Returns:
the type or QString() if not specified

Definition at line 182 of file kdesktopfile.cpp.

QString KDesktopFile::readUrl (  )  const

Returns the value of the "URL=" entry.

Returns:
the URL or QString() if not specified

Definition at line 226 of file kdesktopfile.cpp.

const char * KDesktopFile::resource (  )  const

Definition at line 382 of file kdesktopfile.cpp.

QStringList KDesktopFile::sortOrder (  )  const

Returns the entry of the "SortOrder=" entry.

Returns:
the value of the "SortOrder=" entry.
the filename as passed to the constructor.
the resource type as passed to the constructor.

Definition at line 356 of file kdesktopfile.cpp.

bool KDesktopFile::tryExec (  )  const

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 284 of file kdesktopfile.cpp.


The documentation for this class was generated from the following files:
  • kdesktopfile.h
  • kdesktopfile.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal