KDesktopFile

#include <KDesktopFile>

Inheritance diagram for KDesktopFile:

Public Member Functions

 KDesktopFile (QStandardPaths::StandardLocation resourceType, const QString &fileName)
 
 KDesktopFile (const QString &fileName)
 
virtual ~KDesktopFile ()
 
KConfigGroup actionGroup (const QString &group)
 
const KConfigGroup actionGroup (const QString &group) const
 
KDesktopFilecopyTo (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 noDisplay () const
 
QStringList readActions () const
 
QString readComment () const
 
QString readDevice () const
 
QString readDocPath () const
 
QString readGenericName () const
 
QString readIcon () const
 
QStringList readMimeTypes () const
 
QString readName () const
 
QString readPath () const
 
QString readType () const
 
QString readUrl () const
 
QStandardPaths::StandardLocation resource () const
 
QStringList sortOrder () const
 
bool tryExec () const
 
- Public Member Functions inherited from KConfig
 KConfig (const QString &file=QString(), OpenFlags mode=FullConfig, QStandardPaths::StandardLocation type=QStandardPaths::GenericConfigLocation)
 
 KConfig (const QString &file, const QString &backend, QStandardPaths::StandardLocation type=QStandardPaths::GenericConfigLocation)
 
void checkUpdate (const QString &id, const QString &updateFile)
 
KConfigcopyTo (const QString &file, KConfig *config=nullptr) const
 
QMap< QString, QStringentryMap (const QString &aGroup=QString()) const
 
QStringList groupList () const override
 
bool isDirty () const
 
QStandardPaths::StandardLocation locationType () const
 
void markAsClean () override
 
QString name () const
 
OpenFlags openFlags () const
 
void reparseConfiguration ()
 
bool sync () override
 
AccessMode accessMode () const override
 
bool isConfigWritable (bool warnUser)
 
void addConfigSources (const QStringList &sources)
 
QStringList additionalConfigSources () const
 
QString locale () const
 
bool setLocale (const QString &aLocale)
 
void setReadDefaults (bool b)
 
bool readDefaults () const
 
bool isImmutable () const override
 
void setForceGlobal (bool force)
 
bool forceGlobal () const
 
- Public Member Functions inherited from KConfigBase
virtual ~KConfigBase ()
 
void deleteGroup (const QString &group, WriteConfigFlags flags=Normal)
 
void deleteGroup (const QByteArray &group, WriteConfigFlags flags=Normal)
 
void deleteGroup (const char *group, WriteConfigFlags flags=Normal)
 
KConfigGroup group (const QString &group)
 
KConfigGroup group (const QByteArray &group)
 
KConfigGroup group (const char *group)
 
const KConfigGroup group (const QString &group) const
 
const KConfigGroup group (const QByteArray &group) const
 
const KConfigGroup group (const char *group) const
 
bool hasGroup (const QString &group) const
 
bool hasGroup (const char *group) const
 
bool hasGroup (const QByteArray &group) const
 
bool isGroupImmutable (const QString &group) const
 
bool isGroupImmutable (const QByteArray &group) const
 
bool isGroupImmutable (const char *group) const
 

Static Public Member Functions

static bool isAuthorizedDesktopFile (const QString &path)
 
static bool isDesktopFile (const QString &path)
 
static QString locateLocal (const QString &path)
 
- Static Public Member Functions inherited from KConfig
static void setMainConfigName (const QString &str)
 

Additional Inherited Members

- Public Types inherited from KConfig
enum  OpenFlag {
  IncludeGlobals = 0x01, CascadeConfig = 0x02, SimpleConfig = 0x00, NoCascade = IncludeGlobals,
  NoGlobals = CascadeConfig, FullConfig = IncludeGlobals | CascadeConfig
}
 
typedef QFlags< OpenFlagOpenFlags
 
- Public Types inherited from KConfigBase
enum  AccessMode { NoAccess, ReadOnly, ReadWrite }
 
enum  WriteConfigFlag {
  Persistent = 0x01, Global = 0x02, Localized = 0x04, Notify = 0x08 | Persistent,
  Normal = Persistent
}
 
typedef QFlags< WriteConfigFlagWriteConfigFlags
 
- Protected Member Functions inherited from KConfig
 KConfig (KConfigPrivate &d)
 
void deleteGroupImpl (const QByteArray &group, WriteConfigFlags flags=Normal) override
 
KConfigGroup groupImpl (const QByteArray &b) override
 
const KConfigGroup groupImpl (const QByteArray &b) const override
 
bool hasGroupImpl (const QByteArray &group) const override
 
bool isGroupImmutableImpl (const QByteArray &aGroup) const override
 
void virtual_hook (int id, void *data) override
 
- Protected Attributes inherited from KConfig
KConfigPrivate *const d_ptr
 

Detailed Description

KDE Desktop File Management.

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

Author
Pietro Iglio iglio[email protected]@kde[email protected].org
See also
KConfigBase KConfig
Desktop Entry Spec

Definition at line 26 of file kdesktopfile.h.

Constructor & Destructor Documentation

KDesktopFile::KDesktopFile ( QStandardPaths::StandardLocation  resourceType,
const QString fileName 
)
explicit

Constructs a KDesktopFile object.

See QStandardPaths for more information on resources.

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

Definition at line 41 of file kdesktopfile.cpp.

KDesktopFile::KDesktopFile ( const QString fileName)
explicit

Constructs a KDesktopFile object.

See QStandardPaths for more information on resources.

Parameters
fileNameThe name or path of the desktop file. If it is not absolute, it will be located using the resource type ApplicationsLocation

Definition at line 49 of file kdesktopfile.cpp.

KDesktopFile::~KDesktopFile ( )
virtual

Destructs the KDesktopFile object.

Writes back any dirty configuration entries.

Definition at line 57 of file kdesktopfile.cpp.

Member Function Documentation

KConfigGroup KDesktopFile::actionGroup ( const QString group)

Sets the desktop action group.

Parameters
groupthe new action group

Definition at line 242 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
filethe new KDesktopFile object it will save itself to.

Definition at line 343 of file kdesktopfile.cpp.

bool KDesktopFile::hasActionGroup ( const QString group) const

Returns true if the action group exists, false otherwise.

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

Definition at line 252 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 262 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 267 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 257 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 that desktop files that are not in a standard location (as specified by XDG_DATA_DIRS) must have their executable bit set to be authorized, regardless of KIOSK settings, to prevent users from inadvertently running trojan desktop files.

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

Definition at line 102 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
paththe path of the file to check
Returns
true if the file appears to be a desktop file.

Definition at line 97 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 67 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 362 of file kdesktopfile.cpp.

QStringList KDesktopFile::readActions ( ) const

Returns a list of the "Actions=" entries.

Returns
the list of actions

Definition at line 230 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 186 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 208 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 337 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 192 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 174 of file kdesktopfile.cpp.

QStringList KDesktopFile::readMimeTypes ( ) const

Returns a list of the "MimeType=" entries.

Returns
the list of mime types
Since
5.15

Definition at line 236 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 180 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 198 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 168 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 214 of file kdesktopfile.cpp.

QStringList KDesktopFile::sortOrder ( ) const

Returns the entry of the "SortOrder=" entry.

Returns
the value of the "SortOrder=" entry.
Deprecated:
since 5.42 SortOrder was used to specify the order of menu items, but the Desktop Menu Specification defines another mechanism for it.
Returns
the filename as passed to the constructor.
the resource type as passed to the constructor.

Definition at line 327 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 272 of file kdesktopfile.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Nov 29 2020 22:47:27 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.