You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/kdecore/kdesktopfile.h

252 lines
6.8 KiB

/* This file is part of the KDE libraries
Copyright (c) 1999 Pietro Iglio <iglio@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _KDESKTOPFILE_H
#define _KDESKTOPFILE_H
#include "kconfig.h"
#include "kdelibs_export.h"
class KDesktopFilePrivate;
/**
* KDE Desktop File Management.
*
* @author Pietro Iglio <iglio@kde.org>
* @see KConfigBase KConfig
* @short KDE Desktop File Management class
*/
class KDECORE_EXPORT KDesktopFile : public KConfig
{
Q_OBJECT
public:
/**
* Constructs a KDesktopFile object and make it either read-write
* or read-only.
*
* @param fileName The name or path of the desktop file. If it
* is not absolute, it will be located
* using the resource type @p resType.
* @param readOnly Whether the object should be read-only.
* @param resType Allows you to change what sort of resource
* to search for if @p fileName is not absolute. For
* instance, you might want to specify "config".
*/
KDesktopFile( const QString &fileName, bool readOnly = false,
const char * resType = "apps");
/**
* Destructs the KDesktopFile object.
*
* Writes back any dirty configuration entries.
*/
virtual ~KDesktopFile();
/**
* 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".
* @param path the path of the file to check
* @return true if the file appears to be a desktop file.
*/
static bool isDesktopFile(const QString& path);
/**
* 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.
* @param path the file to check
* @return true if the user is authorized to run the file
* @since 3.1
*/
static bool isAuthorizedDesktopFile(const QString& path);
/**
* Returns the location where changes for the .desktop file @p path
* should be written to.
* @since 3.2
*/
static QString locateLocal(const QString &path);
/**
* Returns the value of the "Type=" entry.
* @return the type or QString::null if not specified
*/
QString readType() const;
/**
* Returns the value of the "Icon=" entry.
* @return the icon or QString::null if not specified
*/
QString readIcon() const;
/**
* Returns the value of the "Name=" entry.
* @return the name or QString::null if not specified
*/
QString readName() const;
/**
* Returns the value of the "Comment=" entry.
* @return the comment or QString::null if not specified
*/
QString readComment() const;
/**
* Returns the value of the "GenericName=" entry.
* @return the generic name or QString::null if not specified
*/
QString readGenericName() const;
/**
* Returns the value of the "Path=" entry.
* @return the path or QString::null if not specified
*/
QString readPath() const;
/**
* Returns the value of the "Dev=" entry.
* @return the device or QString::null if not specified
*/
QString readDevice() const;
/**
* Returns the value of the "URL=" entry.
* @return the URL or QString::null if not specified
*/
QString readURL() const;
/**
* Returns a list of the "Actions=" entries.
* @return the list of actions
*/
QStringList readActions() const;
/**
* Sets the desktop action group.
* @param group the new action group
*/
void setActionGroup(const QString &group);
/**
* Returns true if the action group exists, false otherwise
* @param group the action group to test
* @return true if the action group exists
*/
bool hasActionGroup(const QString &group) const;
/**
* Checks whether there is a "Type=Link" entry.
*
* The link points to the "URL=" entry.
* @return true if there is a "Type=Link" entry
*/
bool hasLinkType() const;
/**
* Checks whether there is an entry "Type=Application".
* @return true if there is a "Type=Application" entry
*/
bool hasApplicationType() const;
/**
* Checks whether there is an entry "Type=MimeType".
* @return true if there is a "Type=MimeType" entry
*/
bool hasMimeTypeType() const; // funny name :)
/**
* Checks whether there is an entry "Type=FSDev".
* @return true if there is a "Type=FSDev" entry
*/
bool hasDeviceType() const;
/**
* Checks whether the TryExec field contains a binary
* which is found on the local system.
* @return true if TryExec contains an existing binary
*/
bool tryExec() const;
/**
* Returns the file name.
* @return The filename as passed to the constructor.
*/
QString fileName() const;
/**
* Returns the resource.
* @return The resource type as passed to the constructor.
*/
QString resource() 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.
* @return The value of the "X-DocPath=" Or "DocPath=" entry.
* @since 3.1
*/
QString readDocPath() const;
/**
* Returns the entry of the "SortOrder=" entry.
* @return the value of the "SortOrder=" entry.
*/
QStringList sortOrder() const;
/**
* Copies all entries from this config object to a new
* KDesktopFile object that will save itself to @p file.
*
* Actual saving to @p file happens when the returned object is
* destructed or when sync() is called upon it.
*
* @param file the new KDesktopFile object it will save itself to.
* @since 3.2
*/
KDesktopFile* copyTo(const QString &file) const;
#ifdef KDE_NO_COMPAT
private:
#endif
/**
* @deprecated Use fileName() instead.
*/
KDE_DEPRECATED QString filename() const { return fileName(); };
private:
// copy-construction and assignment are not allowed
KDesktopFile( const KDesktopFile& );
KDesktopFile& operator= ( const KDesktopFile& );
protected:
virtual void virtual_hook( int id, void* data );
private:
KDesktopFilePrivate *d;
};
#endif