mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-23 18:32:49 +00:00
248 lines
7.2 KiB
C++
248 lines
7.2 KiB
C++
/* 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>
|
|
|
|
class KConfigGroup;
|
|
class KDesktopFilePrivate;
|
|
|
|
/**
|
|
* \class KDesktopFile kdesktopfile.h <KDesktopFile>
|
|
*
|
|
* %KDE Desktop File Management.
|
|
* This class implements %KDE's support for the freedesktop.org
|
|
* <em>Desktop Entry Spec</em>.
|
|
*
|
|
* @author Pietro Iglio <iglio@kde.org>
|
|
* @see KConfigBase KConfig
|
|
* @see <a href="http://standards.freedesktop.org/desktop-entry-spec/latest/">Desktop Entry Spec</a>
|
|
*/
|
|
class KDECORE_EXPORT KDesktopFile : public KConfig
|
|
{
|
|
public:
|
|
/**
|
|
* Constructs a KDesktopFile object.
|
|
*
|
|
* See KStandardDirs for more information on resources.
|
|
*
|
|
* @param resourceType 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".
|
|
* @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.
|
|
*/
|
|
explicit KDesktopFile(const char *resourceType, const QString &fileName);
|
|
|
|
/**
|
|
* Constructs a KDesktopFile object.
|
|
*
|
|
* See KStandardDirs for more information on resources.
|
|
*
|
|
* @param fileName The name or path of the desktop file. If it
|
|
* is not absolute, it will be located
|
|
* using the resource type "apps"
|
|
*/
|
|
explicit KDesktopFile(const QString &fileName);
|
|
|
|
/**
|
|
* 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, the only valid extension is ".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.
|
|
*
|
|
* @param path the file to check
|
|
* @return true if the user is authorized to run the file
|
|
*/
|
|
static bool isAuthorizedDesktopFile(const QString& path);
|
|
|
|
/**
|
|
* Returns the location where changes for the .desktop file @p path
|
|
* should be written to.
|
|
*/
|
|
static QString locateLocal(const QString &path);
|
|
|
|
KConfigGroup desktopGroup() const;
|
|
|
|
/**
|
|
* Returns the value of the "Type=" entry.
|
|
* @return the type or QString() if not specified
|
|
*/
|
|
QString readType() const;
|
|
|
|
/**
|
|
* Returns the value of the "Icon=" entry.
|
|
* @return the icon or QString() if not specified
|
|
*/
|
|
QString readIcon() const;
|
|
|
|
/**
|
|
* Returns the value of the "Name=" entry.
|
|
* @return the name or QString() if not specified
|
|
*/
|
|
QString readName() const;
|
|
|
|
/**
|
|
* Returns the value of the "Comment=" entry.
|
|
* @return the comment or QString() if not specified
|
|
*/
|
|
QString readComment() const;
|
|
|
|
/**
|
|
* Returns the value of the "GenericName=" entry.
|
|
* @return the generic name or QString() if not specified
|
|
*/
|
|
QString readGenericName() const;
|
|
|
|
/**
|
|
* Returns the value of the "Path=" entry.
|
|
* @return the path or QString() if not specified
|
|
*/
|
|
QString readPath() const;
|
|
|
|
/**
|
|
* Returns the value of the "Dev=" entry.
|
|
* @return the device or QString() if not specified
|
|
*/
|
|
QString readDevice() const;
|
|
|
|
/**
|
|
* Returns the value of the "URL=" entry.
|
|
* @return the URL or QString() 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
|
|
*/
|
|
KConfigGroup actionGroup(const QString &group) const;
|
|
|
|
/**
|
|
* 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=FSDevice".
|
|
* @return true if there is a "Type=FSDevice" 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 value of the "X-DocPath=".
|
|
* @return The value of the "X-DocPath=".
|
|
*/
|
|
QString readDocPath() const;
|
|
|
|
/**
|
|
* Returns the entry of the "SortOrder=" entry.
|
|
* @return the value of the "SortOrder=" entry.
|
|
*/
|
|
QStringList sortOrder() const;
|
|
|
|
/**
|
|
* Whether the entry should be suppressed in menus.
|
|
* This handles the NoDisplay key, but also OnlyShowIn / NotShowIn.
|
|
* @return true to suppress this service
|
|
* @since 4.1
|
|
*/
|
|
bool noDisplay() 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.
|
|
*/
|
|
KDesktopFile* copyTo(const QString &file) const;
|
|
|
|
/**
|
|
* @return the filename as passed to the constructor.
|
|
*/
|
|
QString fileName() const;
|
|
|
|
/**
|
|
* @return the resource type as passed to the constructor.
|
|
*/
|
|
const char *resource() const;
|
|
|
|
private:
|
|
Q_DISABLE_COPY(KDesktopFile)
|
|
Q_DECLARE_PRIVATE(KDesktopFile)
|
|
};
|
|
|
|
#endif // KDESKTOPFILE_H
|