• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Member Functions | Static Public Member Functions | Protected Member Functions
KDesktopFile Class Reference

#include <kdesktopfile.h>

Inheritance diagram for KDesktopFile:
KConfig KConfigBase

List of all members.

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
KDE_DEPRECATED TQString filename () 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)

Detailed Description

KDE Desktop File Management.

Author:
Pietro Iglio <iglio@kde.org>
See also:
KConfigBase KConfig KDE Desktop File Management class

Definition at line 34 of file kdesktopfile.h.


Constructor & Destructor Documentation

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:
fileNameThe name or path of the desktop file. If it is not absolute, it will be located using the resource type resType.
readOnlyWhether the object should be read-only.
resTypeAllows 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 ( ) [virtual]

Destructs the KDesktopFile object.

Writes back any dirty configuration entries.

Definition at line 56 of file kdesktopfile.cpp.


Member Function Documentation

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:
filethe new KDesktopFile object it will save itself to.
Since:
3.2

Definition at line 361 of file kdesktopfile.cpp.

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

KDE_DEPRECATED TQString KDesktopFile::filename ( ) const [inline]
Deprecated:
Use fileName() instead.

Definition at line 235 of file kdesktopfile.h.

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

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.

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.

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.

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:
paththe 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.

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:
paththe 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.

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.

TQStringList KDesktopFile::readActions ( ) const

Returns a list of the "Actions=" entries.

Returns:
the list of actions

Definition at line 237 of file kdesktopfile.cpp.

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.

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.

TQString KDesktopFile::readDocPath ( ) const

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

X-DocPath should be used and DocPath is depreciated and will one day be not supported.

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

Definition at line 351 of file kdesktopfile.cpp.

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.

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.

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.

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.

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.

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.

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

void KDesktopFile::setActionGroup ( const TQString &  group)

Sets the desktop action group.

Parameters:
groupthe new action group

Definition at line 242 of file kdesktopfile.cpp.

TQStringList KDesktopFile::sortOrder ( ) const

Returns the entry of the "SortOrder=" entry.

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

Definition at line 343 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 273 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

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |