KDesktopFile

Search for usage in LXR

#include <KDesktopFile>

Inheritance diagram for KDesktopFile:

Public Member Functions

 KDesktopFile (const QString &fileName)
 
 KDesktopFile (QStandardPaths::StandardLocation resourceType, const QString &fileName)
 
 ~KDesktopFile () override
 
KConfigGroup actionGroup (const QString &group)
 
KConfigGroup actionGroup (const QString &group) const
 
QList< KDesktopFileActionactions () 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 readDocPath () const
 
QString readGenericName () const
 
QString readIcon () const
 
QStringList readMimeTypes () const
 
QString readName () const
 
QString readPath () const
 
QString readType () const
 
QString readUrl () const
 
bool tryExec () const
 
- Public Member Functions inherited from KConfig
 KConfig (const QString &file, const QString &backend, QStandardPaths::StandardLocation type=QStandardPaths::GenericConfigLocation)
 
 KConfig (const QString &file=QString(), OpenFlags mode=FullConfig, 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
 
- Public Member Functions inherited from KConfigBase
virtual ~KConfigBase ()
 
void deleteGroup (const QString &group, WriteConfigFlags flags=Normal)
 
KConfigGroup group (const QString &group)
 
const KConfigGroup group (const QString &group) const
 
bool hasGroup (const QString &group) const
 
bool isGroupImmutable (const QString &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 QString mainConfigName ()
 
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
KCONFIGCORE_NO_EXPORT KConfig (KConfigPrivate &d)
 
void deleteGroupImpl (const QString &groupName, WriteConfigFlags flags=Normal) override
 
const KConfigGroup groupImpl (const QString &groupName) const override
 
KConfigGroup groupImpl (const QString &groupName) override
 
bool hasGroupImpl (const QString &groupName) const override
 
bool isGroupImmutableImpl (const QString &groupName) 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.nosp@m.@kde.nosp@m..org
See also
KConfigBase KConfig
Desktop Entry Spec

Definition at line 27 of file kdesktopfile.h.

Constructor & Destructor Documentation

◆ KDesktopFile() [1/2]

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

◆ KDesktopFile() [2/2]

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

◆ ~KDesktopFile()

KDesktopFile::~KDesktopFile ( )
overridedefault

Destructs the KDesktopFile object.

Writes back any changed configuration entries.

Member Function Documentation

◆ actionGroup() [1/2]

KConfigGroup KDesktopFile::actionGroup ( const QString & group)

Sets the desktop action group.

Parameters
groupthe new action group

Definition at line 227 of file kdesktopfile.cpp.

◆ actionGroup() [2/2]

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

Definition at line 232 of file kdesktopfile.cpp.

◆ actions()

QList< KDesktopFileAction > KDesktopFile::actions ( ) const
Since
6.0

Definition at line 312 of file kdesktopfile.cpp.

◆ copyTo()

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

◆ desktopGroup()

KConfigGroup KDesktopFile::desktopGroup ( ) const

Returns the main config group (named "Desktop Entry") in a .desktop file.

Definition at line 57 of file kdesktopfile.cpp.

◆ fileName()

QString KDesktopFile::fileName ( ) const

Returns the name of the .desktop file that was used to construct this KDesktopFile.

Definition at line 301 of file kdesktopfile.cpp.

◆ hasActionGroup()

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

◆ hasApplicationType()

bool KDesktopFile::hasApplicationType ( ) const

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

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

Definition at line 247 of file kdesktopfile.cpp.

◆ hasDeviceType()

bool KDesktopFile::hasDeviceType ( ) const

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

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

Definition at line 252 of file kdesktopfile.cpp.

◆ hasLinkType()

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

◆ isAuthorizedDesktopFile()

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

◆ isDesktopFile()

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

◆ locateLocal()

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

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

Definition at line 63 of file kdesktopfile.cpp.

◆ noDisplay()

bool KDesktopFile::noDisplay ( ) const

Whether the entry should be suppressed in menus.

This handles the NoDisplay key

Returns
true to suppress this desktop file
Since
4.1

Definition at line 306 of file kdesktopfile.cpp.

◆ readActions()

QStringList KDesktopFile::readActions ( ) const

Returns a list of the "Actions=" entries.

Returns
the list of actions

Definition at line 215 of file kdesktopfile.cpp.

◆ readComment()

QString KDesktopFile::readComment ( ) const

Returns the value of the "Comment=" entry.

Returns
the comment or QString() if not specified

Definition at line 177 of file kdesktopfile.cpp.

◆ readDocPath()

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

◆ readGenericName()

QString KDesktopFile::readGenericName ( ) const

Returns the value of the "GenericName=" entry.

Returns
the generic name or QString() if not specified

Definition at line 183 of file kdesktopfile.cpp.

◆ readIcon()

QString KDesktopFile::readIcon ( ) const

Returns the value of the "Icon=" entry.

Returns
the icon or QString() if not specified

Definition at line 165 of file kdesktopfile.cpp.

◆ readMimeTypes()

QStringList KDesktopFile::readMimeTypes ( ) const

Returns a list of the "MimeType=" entries.

Returns
the list of mime types
Since
5.15

Definition at line 221 of file kdesktopfile.cpp.

◆ readName()

QString KDesktopFile::readName ( ) const

Returns the value of the "Name=" entry.

Returns
the name or QString() if not specified

Definition at line 171 of file kdesktopfile.cpp.

◆ readPath()

QString KDesktopFile::readPath ( ) const

Returns the value of the "Path=" entry.

Returns
the path or QString() if not specified

Definition at line 189 of file kdesktopfile.cpp.

◆ readType()

QString KDesktopFile::readType ( ) const

Returns the value of the "Type=" entry.

Returns
the type or QString() if not specified

Definition at line 159 of file kdesktopfile.cpp.

◆ readUrl()

QString KDesktopFile::readUrl ( ) const

Returns the value of the "URL=" entry.

Returns
the URL or QString() if not specified

Definition at line 199 of file kdesktopfile.cpp.

◆ tryExec()

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 257 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-2024 The KDE developers.
Generated on Fri May 17 2024 11:52:47 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.