#include <kdesktopfile.h>

Inheritance diagram for KDesktopFile:

Public Member Functions
	KDesktopFile (const TQString &fileName, bool readOnly=false, const char *resType="apps")

virtual	~KDesktopFile ()

TQString	readType () const

TQString	readIcon () const

TQString	readName () const

TQString	readComment () const

TQString	readGenericName () const

TQString	readPath () const

TQString	readDevice () const

TQString	readURL () const

TQStringList	readActions () const

void	setActionGroup (const TQString &group)

bool	hasActionGroup (const TQString &group) const

bool	hasLinkType () const

bool	hasApplicationType () const

bool	hasMimeTypeType () const

bool	hasDeviceType () const

bool	tryExec () const

TQString	fileName () const

TQString	resource () const

TQString	readDocPath () const

TQStringList	sortOrder () const

KDesktopFile *	copyTo (const TQString &file) const

TDE_DEPRECATED TQString	filename () const

Public Member Functions inherited from TDEConfig
	TDEConfig (const TQString &fileName=TQString::null, bool bReadOnly=false, bool bUseKDEGlobals=true, const char *resType="config")

	TDEConfig (TDEConfigBackEnd *backEnd, bool bReadOnly=false)

virtual	~TDEConfig ()

virtual void	rollback (bool bDeep=true)

virtual TQStringList	groupList () const

virtual TQMap< TQString, TQString >	entryMap (const TQString &pGroup) const

virtual void	reparseConfiguration ()

void	setFileWriteMode (int mode)

void	setForceGlobal (bool force)

bool	forceGlobal () const

void	checkUpdate (const TQString &id, const TQString &updateFile)

TDEConfig *	copyTo (const TQString &file, TDEConfig *config=0) const

TDELockFile::Ptr	lockFile (bool bGlobal=false)

Public Member Functions inherited from TDEConfigBase
	TDEConfigBase ()

virtual	~TDEConfigBase ()

void	setGroup (const TQString &group)

void	setDesktopGroup ()

TQString	group () const

bool	hasGroup (const TQString &group) const

virtual TQStringList	groupList () const =0

TQString	locale () const

TQString	readEntry (const TQString &pKey, const TQString &aDefault=TQString::null) const

TQString	readEntry (const char *pKey, const TQString &aDefault=TQString::null) const

TQVariant	readPropertyEntry (const TQString &pKey, TQVariant::Type) const

TQVariant	readPropertyEntry (const char *pKey, TQVariant::Type) const

TQVariant	readPropertyEntry (const TQString &pKey, const TQVariant &aDefault) const

TQVariant	readPropertyEntry (const char *pKey, const TQVariant &aDefault) const

int	readListEntry (const TQString &pKey, TQStrList &list, char sep=',') const

int	readListEntry (const char *pKey, TQStrList &list, char sep=',') const

TQStringList	readListEntry (const TQString &pKey, char sep=',') const

TQStringList	readListEntry (const char *pKey, char sep=',') const

TQStringList	readListEntry (const char *pKey, const TQStringList &aDefault, char sep=',') const

TQValueList< int >	readIntListEntry (const TQString &pKey) const

TQValueList< int >	readIntListEntry (const char *pKey) const

TQString	readPathEntry (const TQString &pKey, const TQString &aDefault=TQString::null) const

TQString	readPathEntry (const char *pKey, const TQString &aDefault=TQString::null) const

TQStringList	readPathListEntry (const TQString &pKey, char sep=',') const

TQStringList	readPathListEntry (const char *pKey, char sep=',') const

int	readNumEntry (const TQString &pKey, int nDefault=0) const

int	readNumEntry (const char *pKey, int nDefault=0) const

unsigned int	readUnsignedNumEntry (const TQString &pKey, unsigned int nDefault=0) const

unsigned int	readUnsignedNumEntry (const char *pKey, unsigned int nDefault=0) const

long	readLongNumEntry (const TQString &pKey, long nDefault=0) const

long	readLongNumEntry (const char *pKey, long nDefault=0) const

unsigned long	readUnsignedLongNumEntry (const TQString &pKey, unsigned long nDefault=0) const

unsigned long	readUnsignedLongNumEntry (const char *pKey, unsigned long nDefault=0) const

TQ_INT64	readNum64Entry (const TQString &pKey, TQ_INT64 nDefault=0) const

TQ_INT64	readNum64Entry (const char *pKey, TQ_INT64 nDefault=0) const

TQ_UINT64	readUnsignedNum64Entry (const TQString &pKey, TQ_UINT64 nDefault=0) const

TQ_UINT64	readUnsignedNum64Entry (const char *pKey, TQ_UINT64 nDefault=0) const

double	readDoubleNumEntry (const TQString &pKey, double nDefault=0.0) const

double	readDoubleNumEntry (const char *pKey, double nDefault=0.0) const

TQFont	readFontEntry (const TQString &pKey, const TQFont *pDefault=0L) const

TQFont	readFontEntry (const char pKey, const TQFont pDefault=0L) const

bool	readBoolEntry (const TQString &pKey, bool bDefault=false) const

bool	readBoolEntry (const char *pKey, bool bDefault=false) const

TQRect	readRectEntry (const TQString &pKey, const TQRect *pDefault=0L) const

TQRect	readRectEntry (const char pKey, const TQRect pDefault=0L) const

TQPoint	readPointEntry (const TQString &pKey, const TQPoint *pDefault=0L) const

TQPoint	readPointEntry (const char pKey, const TQPoint pDefault=0L) const

TQSize	readSizeEntry (const TQString &pKey, const TQSize *pDefault=0L) const

TQSize	readSizeEntry (const char pKey, const TQSize pDefault=0L) const

TQColor	readColorEntry (const TQString &pKey, const TQColor *pDefault=0L) const

TQColor	readColorEntry (const char pKey, const TQColor pDefault=0L) const

TQDateTime	readDateTimeEntry (const TQString &pKey, const TQDateTime *pDefault=0L) const

TQDateTime	readDateTimeEntry (const char pKey, const TQDateTime pDefault=0L) const

TQString	readEntryUntranslated (const TQString &pKey, const TQString &aDefault=TQString::null) const

TQString	readEntryUntranslated (const char *pKey, const TQString &aDefault=TQString::null) const

void	writeEntry (const TQString &pKey, const TQString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQStrList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQStrList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char pKey, const char pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, TQ_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, TQ_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, TQ_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, TQ_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format='g', int precision=6, bool bNLS=false)

void	writeEntry (const char *pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format='g', int precision=6, bool bNLS=false)

void	writeEntry (const TQString &pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const TQString &pKey, const TQSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writeEntry (const char *pKey, const TQSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writePathEntry (const TQString &pKey, const TQString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writePathEntry (const char *pKey, const TQString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writePathEntry (const char *pKey, const TQString &path, bool bPersistent, bool bGlobal, bool bNLS, bool expand)

void	writePathEntry (const TQString &pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	writePathEntry (const char *pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

void	deleteEntry (const TQString &pKey, bool bNLS=false, bool bGlobal=false)

void	deleteEntry (const char *pKey, bool bNLS=false, bool bGlobal=false)

bool	deleteGroup (const TQString &group, bool bDeep=true, bool bGlobal=false)

void	setDollarExpansion (bool _bExpand=true)

bool	isDollarExpansion () const

virtual void	rollback (bool bDeep=true)

virtual void	sync ()

bool	isDirty () const

virtual void	setReadOnly (bool _ro)

bool	isReadOnly () const

bool	hasKey (const TQString &key) const

virtual TQMap< TQString, TQString >	entryMap (const TQString &group) const =0

virtual void	reparseConfiguration ()=0

bool	isImmutable () const

bool	groupIsImmutable (const TQString &group) const

bool	entryIsImmutable (const TQString &key) const

ConfigState	getConfigState () const

bool	checkConfigFilesWritable (bool warnUser)

void	setReadDefaults (bool b)

bool	readDefaults () const

void	revertToDefault (const TQString &key)

bool	hasDefault (const TQString &key) const

void	setGroup (const TQCString &pGroup)

void	setGroup (const char *pGroup)

bool	hasGroup (const TQCString &_pGroup) const

bool	hasGroup (const char *_pGroup) const

bool	hasKey (const char *pKey) const

Static Public Member Functions
static bool	isDesktopFile (const TQString &path)

static bool	isAuthorizedDesktopFile (const TQString &path)

static TQString	locateLocal (const TQString &path)

Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Protected Member Functions inherited from TDEConfig
virtual bool	internalHasGroup (const TQCString &group) const

virtual KEntryMap	internalEntryMap (const TQString &pGroup) const

virtual KEntryMap	internalEntryMap () const

virtual void	putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)

virtual KEntry	lookupData (const KEntryKey &_key) const

virtual void	virtual_hook (int id, void *data)

Protected Member Functions inherited from TDEConfigBase
void	setLocale ()

virtual void	setDirty (bool _bDirty=true)

virtual void	parseConfigFiles ()

virtual KEntryMap	internalEntryMap (const TQString &pGroup) const =0

virtual KEntryMap	internalEntryMap () const =0

virtual void	putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)=0

virtual KEntry	lookupData (const KEntryKey &_key) const =0

virtual bool	internalHasGroup (const TQCString &group) const =0

TQCString	readEntryUtf8 (const char *pKey) const

bool	hasTranslatedKey (const char *pKey) const

virtual void	virtual_hook (int id, void *data)

Additional Inherited Members
Public Types inherited from TDEConfigBase
enum	ConfigState { NoAccess , ReadOnly , ReadWrite }

Protected Attributes inherited from TDEConfig
KEntryMap	aEntryMap

Protected Attributes inherited from TDEConfigBase
TDEConfigBackEnd *	backEnd

TQCString	mGroup

TQCString	aLocaleString

bool	bDirty

bool	bLocaleInitialized

bool	bReadOnly

bool	bExpand

Detailed Description

KDE Desktop File Management.

Author: Pietro Iglio iglio.nosp@m.@kde.nosp@m..org

See also: TDEConfigBase TDEConfig

KDE Desktop File Management class

Definition at line 34 of file kdesktopfile.h.

Constructor & Destructor Documentation

◆ KDesktopFile()

KDesktopFile::KDesktopFile	(	const TQString &	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 43 of file kdesktopfile.cpp.

◆ ~KDesktopFile()

KDesktopFile::~KDesktopFile ( )

virtual

Destructs the KDesktopFile object.

Writes back any dirty configuration entries.

Definition at line 56 of file kdesktopfile.cpp.

Member Function Documentation

◆ copyTo()

KDesktopFile * KDesktopFile::copyTo ( const TQString & 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 370 of file kdesktopfile.cpp.

◆ fileName()

TQString KDesktopFile::fileName ( ) const

Returns the file name.

Returns: The filename as passed to the constructor.; the filename as passed to the constructor.

Definition at line 348 of file kdesktopfile.cpp.

◆ filename()

TDE_DEPRECATED TQString KDesktopFile::filename ( ) const

inline

Deprecated:: Use fileName() instead.

Definition at line 233 of file kdesktopfile.h.

◆ hasActionGroup()

bool KDesktopFile::hasActionGroup ( const TQString & 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 247 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 257 of file kdesktopfile.cpp.

◆ hasDeviceType()

bool KDesktopFile::hasDeviceType ( ) const

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

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

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

◆ hasMimeTypeType()

bool KDesktopFile::hasMimeTypeType ( ) const

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

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

Definition at line 262 of file kdesktopfile.cpp.

◆ isAuthorizedDesktopFile()

bool KDesktopFile::isAuthorizedDesktopFile ( const TQString & 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 125 of file kdesktopfile.cpp.

◆ isDesktopFile()

bool KDesktopFile::isDesktopFile ( const TQString & 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 113 of file kdesktopfile.cpp.

◆ locateLocal()

TQString KDesktopFile::locateLocal ( const TQString & path )

static

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

Since: 3.2

Definition at line 61 of file kdesktopfile.cpp.

◆ readActions()

TQStringList KDesktopFile::readActions ( ) const

Returns a list of the "Actions=" entries.

Returns: the list of actions

Definition at line 237 of file kdesktopfile.cpp.

◆ readComment()

TQString KDesktopFile::readComment ( ) const

Returns the value of the "Comment=" entry.

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

Definition at line 186 of file kdesktopfile.cpp.

◆ readDevice()

TQString KDesktopFile::readDevice ( ) const

Returns the value of the "Dev=" entry.

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

Definition at line 201 of file kdesktopfile.cpp.

◆ readDocPath()

TQString KDesktopFile::readDocPath ( ) const

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

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

Since: 3.1

Definition at line 365 of file kdesktopfile.cpp.

◆ readGenericName()

TQString KDesktopFile::readGenericName ( ) const

Returns the value of the "GenericName=" entry.

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

Definition at line 191 of file kdesktopfile.cpp.

◆ readIcon()

TQString KDesktopFile::readIcon ( ) const

Returns the value of the "Icon=" entry.

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

Definition at line 176 of file kdesktopfile.cpp.

◆ readName()

TQString KDesktopFile::readName ( ) const

Returns the value of the "Name=" entry.

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

Definition at line 181 of file kdesktopfile.cpp.

◆ readPath()

TQString KDesktopFile::readPath ( ) const

Returns the value of the "Path=" entry.

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

Definition at line 196 of file kdesktopfile.cpp.

◆ readType()

TQString KDesktopFile::readType ( ) const

Returns the value of the "Type=" entry.

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

Definition at line 171 of file kdesktopfile.cpp.

◆ readURL()

TQString KDesktopFile::readURL ( ) const

Returns the value of the "URL=" entry.

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

Definition at line 206 of file kdesktopfile.cpp.

◆ resource()

TQString KDesktopFile::resource ( ) const

Returns the resource.

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

Definition at line 354 of file kdesktopfile.cpp.

◆ setActionGroup()

void KDesktopFile::setActionGroup ( const TQString & group )

Sets the desktop action group.

Parameters

group the new action group

Definition at line 242 of file kdesktopfile.cpp.

◆ sortOrder()

TQStringList KDesktopFile::sortOrder ( ) const

Returns the entry of the "SortOrder=" entry.

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

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

◆ virtual_hook()

void KDesktopFile::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

Reimplemented from TDEConfig.

Definition at line 362 of file kdesktopfile.cpp.

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

tdecore

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KDesktopFile()

◆ ~KDesktopFile()

Member Function Documentation

◆ copyTo()

◆ fileName()

◆ filename()

◆ hasActionGroup()

◆ hasApplicationType()

◆ hasDeviceType()

◆ hasLinkType()

◆ hasMimeTypeType()

◆ isAuthorizedDesktopFile()

◆ isDesktopFile()

◆ locateLocal()

◆ readActions()

◆ readComment()

◆ readDevice()

◆ readDocPath()

◆ readGenericName()

◆ readIcon()

◆ readName()

◆ readPath()

◆ readType()

◆ readURL()

◆ resource()

◆ setActionGroup()

◆ sortOrder()

◆ tryExec()

◆ virtual_hook()

tdecore

tdecore