Initial import from the monolithic kdelibs.

This is the beginning of revision history for this module. If you
want to look at revision history older than this, please refer to the
techbase wiki for how to use Git history grafting. At the time of
writing, this wiki is located here:

http://community.kde.org/Frameworks/GitOldHistory

If you have already performed the grafting and you don't see any
history beyond this commit, try running "git log" with the "--follow"
argument.

Branched from the monolithic repo, kdelibs frameworks branch, at commit
162066dbbecde401a7347a1cff4fe72a9c919f58

1 files changed, 252 insertions, 0 deletions

diff --git a/tier1/kconfig/src/core/kdesktopfile.h b/tier1/kconfig/src/core/kdesktopfile.h
new file mode 100644
index 00000000..f3c5fe8f
--- /dev/null
+++ b/tier1/kconfig/src/core/kdesktopfile.h
@@ -0,0 +1,252 @@
+/* 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 KCONFIGCORE_EXPORT KDesktopFile : public KConfig
+{
+public:
+  /**
+   * Constructs a KDesktopFile object.
+   *
+   * See QStandardPaths 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 GenericConfigLocation.
+   * @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(QStandardPaths::StandardLocation resourceType, const QString &fileName);
+
+  /**
+   * Constructs a KDesktopFile object.
+   *
+   * See QStandardPaths 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 ApplicationsLocation
+   */
+  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 but
+   * the KIOSK framework can be used to activate certain restrictions.
+   * See README.kiosk for more information.
+   *
+   * Note: Since KDE 4.3, there are more restrictions on authorized
+   * desktop files to prevent users from inadvertently running trojan
+   * desktop files.  Your application launchers should have the executable
+   * bit set to prevent issues.  To see if a restriction is due to
+   * KIOSK, see KAuthorized.
+   *
+   * @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 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=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=" Or "DocPath=" entry.
+   * @return The value of the "X-DocPath=" Or "DocPath=" entry.
+   */
+  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;
+
+  QString fileName() const;
+
+  QStandardPaths::StandardLocation resource() const;
+
+protected:
+  /** Virtual hook, used to add new "virtual" functions while maintaining
+      binary compatibility. Unused in this class.
+  */
+//  virtual void virtual_hook( int id, void* data );
+private:
+
+  Q_DISABLE_COPY(KDesktopFile)
+
+  Q_DECLARE_PRIVATE(KDesktopFile)
+};
+
+#endif