KDesktopFile Class Reference
#include <kdesktopfile.h>
Inheritance diagram for KDesktopFile:

Detailed Description
KDE Desktop File Management.KDE Desktop File Management class.
- See also:
- KConfigBase KConfig
Definition at line 34 of file kdesktopfile.h.
Public Member Functions | |
KDesktopFile (const QString &fileName, bool readOnly=false, const char *resType="apps") | |
virtual | ~KDesktopFile () |
QString | readType () const |
QString | readIcon () const |
QString | readName () const |
QString | readComment () const |
QString | readGenericName () const |
QString | readPath () const |
QString | readDevice () const |
QString | readURL () const |
QStringList | readActions () const |
void | setActionGroup (const QString &group) |
bool | hasActionGroup (const QString &group) const |
bool | hasLinkType () const |
bool | hasApplicationType () const |
bool | hasMimeTypeType () const |
bool | hasDeviceType () const |
bool | tryExec () const |
QString | fileName () const |
QString | resource () const |
QString | readDocPath () const |
QStringList | sortOrder () const |
KDesktopFile * | copyTo (const QString &file) const |
KDE_DEPRECATED QString | filename () const |
Static Public Member Functions | |
static bool | isDesktopFile (const QString &path) |
static bool | isAuthorizedDesktopFile (const QString &path) |
static QString | locateLocal (const QString &path) |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Constructor & Destructor Documentation
KDesktopFile::KDesktopFile | ( | const QString & | 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 | ( | ) | [virtual] |
Destructs the KDesktopFile object.
Writes back any dirty configuration entries.
Definition at line 56 of file kdesktopfile.cpp.
Member Function Documentation
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, 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.
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.
- 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.
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.
QString KDesktopFile::readType | ( | ) | const |
Returns the value of the "Type=" entry.
- Returns:
- the type or QString::null if not specified
Definition at line 171 of file kdesktopfile.cpp.
QString KDesktopFile::readIcon | ( | ) | const |
Returns the value of the "Icon=" entry.
- Returns:
- the icon or QString::null if not specified
Definition at line 176 of file kdesktopfile.cpp.
QString KDesktopFile::readName | ( | ) | const |
Returns the value of the "Name=" entry.
- Returns:
- the name or QString::null if not specified
Definition at line 181 of file kdesktopfile.cpp.
QString KDesktopFile::readComment | ( | ) | const |
Returns the value of the "Comment=" entry.
- Returns:
- the comment or QString::null if not specified
Definition at line 186 of file kdesktopfile.cpp.
QString KDesktopFile::readGenericName | ( | ) | const |
Returns the value of the "GenericName=" entry.
- Returns:
- the generic name or QString::null if not specified
Definition at line 191 of file kdesktopfile.cpp.
QString KDesktopFile::readPath | ( | ) | const |
Returns the value of the "Path=" entry.
- Returns:
- the path or QString::null if not specified
Definition at line 196 of file kdesktopfile.cpp.
QString KDesktopFile::readDevice | ( | ) | const |
Returns the value of the "Dev=" entry.
- Returns:
- the device or QString::null if not specified
Definition at line 201 of file kdesktopfile.cpp.
QString KDesktopFile::readURL | ( | ) | const |
Returns the value of the "URL=" entry.
- Returns:
- the URL or QString::null if not specified
Definition at line 206 of file kdesktopfile.cpp.
QStringList KDesktopFile::readActions | ( | ) | const |
Returns a list of the "Actions=" entries.
- Returns:
- the list of actions
Definition at line 237 of file kdesktopfile.cpp.
void KDesktopFile::setActionGroup | ( | const QString & | group | ) |
Sets the desktop action group.
- Parameters:
-
group the new action group
Definition at line 242 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 247 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::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::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::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::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.
QString KDesktopFile::fileName | ( | ) | const |
Returns the file name.
- Returns:
- The filename as passed to the constructor.
Definition at line 334 of file kdesktopfile.cpp.
QString KDesktopFile::resource | ( | ) | const |
Returns the resource.
- Returns:
- The resource type as passed to the constructor.
Definition at line 340 of file kdesktopfile.cpp.
QString 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.
QStringList 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.
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.
- Since:
- 3.2
Definition at line 361 of file kdesktopfile.cpp.
KDE_DEPRECATED QString KDesktopFile::filename | ( | ) | const [inline] |
The documentation for this class was generated from the following files: