Deprecate KDesktopFile::sortOrder()

Summary:
The SortOrder key is deprecated by the Desktop Entry Specification:
https://standards.freedesktop.org/desktop-entry-spec/latest/apc.html

Reviewers: dfaure, #frameworks

Reviewed By: dfaure

Subscribers: #frameworks

Tags: #frameworks

Differential Revision: https://phabricator.kde.org/D9224

3 files changed, 10 insertions, 1 deletions

diff --git a/autotests/kdesktopfiletest.cpp b/autotests/kdesktopfiletest.cpp
index d0a0a262..fd4a5c9e 100644
--- a/autotests/kdesktopfiletest.cpp
+++ b/autotests/kdesktopfiletest.cpp
@@ -62,6 +62,7 @@ void KDesktopFileTest::testRead()
     QCOMPARE(df.fileName(), QFileInfo(fileName).canonicalFilePath());
 }
 
+#ifndef KDE_NO_DEPRECATED
 void KDesktopFileTest::testReadDirectory()
 {
     QTemporaryFile file("testReadDirectoryXXXXXX.directory");
@@ -80,6 +81,7 @@ void KDesktopFileTest::testReadDirectory()
     QCOMPARE(df.sortOrder(), QStringList() << QString::fromLatin1("2.desktop")
                                            << QString::fromLatin1("1.desktop"));
 }
+#endif
 
 void KDesktopFileTest::testReadLocalized_data()
 {
diff --git a/src/core/kdesktopfile.cpp b/src/core/kdesktopfile.cpp
index 8d53ece4..b0b6a878 100644
--- a/src/core/kdesktopfile.cpp
+++ b/src/core/kdesktopfile.cpp
@@ -326,12 +326,14 @@ bool KDesktopFile::tryExec() const
 //QString
 //KDesktopFile::resource() const { return backEnd->resource(); }
 
+#ifndef KDE_NO_DEPRECATED
 QStringList
 KDesktopFile::sortOrder() const
 {
     Q_D(const KDesktopFile);
     return d->desktopGroup.readXdgListEntry("SortOrder");
 }
+#endif
 
 //void KDesktopFile::virtual_hook( int id, void* data )
 //{ KConfig::virtual_hook( id, data ); }
diff --git a/src/core/kdesktopfile.h b/src/core/kdesktopfile.h
index f3b293fa..ca21bc85 100644
--- a/src/core/kdesktopfile.h
+++ b/src/core/kdesktopfile.h
@@ -214,11 +214,16 @@ public:
      */
     QString readDocPath() const;
 
+#ifndef KDE_NO_DEPRECATED
     /**
      * Returns the entry of the "SortOrder=" entry.
      * @return the value of the "SortOrder=" entry.
+     * @deprecated since 5.42
+     * SortOrder was used to specify the order of menu items, but
+     * the Desktop Menu Specification defines another mechanism for it.
      */
-    QStringList sortOrder() const;
+    KCONFIGCORE_DEPRECATED QStringList sortOrder() const;
+#endif
 
     /**
      * Whether the entry should be suppressed in menus.