aboutsummaryrefslogtreecommitdiff
path: root/src/core/kcoreconfigskeleton.h
diff options
context:
space:
mode:
authorFriedrich W. H. Kossebau <kossebau@kde.org>2019-10-08 15:22:49 +0200
committerFriedrich W. H. Kossebau <kossebau@kde.org>2019-10-18 21:23:32 +0200
commitfb37084b3e7c396cd10bf4d3253fee730320988a (patch)
tree3c58974a533b9ec963d315481d38671ba8f10613 /src/core/kcoreconfigskeleton.h
parent3f68be12f87e83b67f9270eb139d894bf65ebef1 (diff)
downloadkconfig-fb37084b3e7c396cd10bf4d3253fee730320988a.tar.gz
kconfig-fb37084b3e7c396cd10bf4d3253fee730320988a.tar.bz2
Use ECMGenerateExportHeader to manage deprecated API better
Summary: Allows * projects linking to KConfigCore/Gui to hide deprecated API up to a given version or silence deprecation warnings after a given version, using * -DKCONFIGCORE_DISABLE_DEPRECATED_BEFORE_AND_AT * -DKCONFIGCORE_NO_DEPRECATED * -DKCONFIGCORE_DEPRECATED_WARNINGS_SINCE * -DKCONFIGCORE_NO_DEPRECATED_WARNINGS * -DKCONFIGGUI_DISABLE_DEPRECATED_BEFORE_AND_AT * -DKCONFIGGUI_NO_DEPRECATED * -DKCONFIGGUI_DEPRECATED_WARNINGS_SINCE * -DKCONFIGGUI_NO_DEPRECATED_WARNINGS or * -DKF_DISABLE_DEPRECATED_BEFORE_AND_AT * -DKF_NO_DEPRECATED * -DKF_DEPRECATED_WARNINGS_SINCE * -DKF_NO_DEPRECATED_WARNINGS * to build KConfigCore/Gui optionally with deprecated API excluded from the build, using "EXCLUDE_DEPRECATED_BEFORE_AND_AT" cmake argument. Test Plan: Builds with EXCLUDE_DEPRECATED_BEFORE_AND_AT set to 0, 4.0.0, 5.0.0, 5.11.0, 5.24.0, 5.39.0, 5.42.0, CURRENT. Reviewers: #frameworks, mlaurent Reviewed By: mlaurent Subscribers: mlaurent, kde-frameworks-devel Tags: #frameworks Differential Revision: https://phabricator.kde.org/D24496
Diffstat (limited to 'src/core/kcoreconfigskeleton.h')
-rw-r--r--src/core/kcoreconfigskeleton.h44
1 files changed, 26 insertions, 18 deletions
diff --git a/src/core/kcoreconfigskeleton.h b/src/core/kcoreconfigskeleton.h
index 16ff0417..76b78a20 100644
--- a/src/core/kcoreconfigskeleton.h
+++ b/src/core/kcoreconfigskeleton.h
@@ -684,8 +684,8 @@ public:
qint64 mMin;
qint64 mMax;
};
-#ifndef KDE_NO_DEPRECATED
- typedef KCONFIGCORE_DEPRECATED ItemLongLong ItemInt64;
+#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
+ typedef KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Use ItemLongLong") ItemLongLong ItemInt64;
#endif
/**
@@ -804,8 +804,8 @@ public:
quint64 mMin;
quint64 mMax;
};
-#ifndef KDE_NO_DEPRECATED
- typedef KCONFIGCORE_DEPRECATED ItemULongLong ItemUInt64;
+#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
+ typedef KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Use ItemULongLong") ItemULongLong ItemUInt64;
#endif
/**
@@ -1076,12 +1076,13 @@ public:
*/
void load();
-#ifndef KCONFIGCORE_NO_DEPRECATED
+#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
/**
* @deprecated since 5.0, call load() instead (to reload from disk) or just read()
* if the underlying KConfig object is already up-to-date.
*/
- KCONFIGCORE_DEPRECATED void readConfig()
+ KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Use KCoreConfigSkeleton::load() or KCoreConfigSkeleton::read()")
+ void readConfig()
{
load();
}
@@ -1261,12 +1262,12 @@ public:
qint64 defaultValue = 0,
const QString &key = QString());
+#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
/**
- * @deprecated
- * Use addItemLongLong().
+ * @deprecated Since 5.0, use addItemLongLong().
*/
-#ifndef KDE_NO_DEPRECATED
- KCONFIGCORE_DEPRECATED ItemLongLong *addItemInt64(const QString &name, qint64 &reference,
+ KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Use KCoreConfigSkeleton::addItemLongLong(...)")
+ ItemLongLong *addItemInt64(const QString &name, qint64 &reference,
qint64 defaultValue = 0,
const QString &key = QString());
#endif
@@ -1286,12 +1287,12 @@ public:
quint64 defaultValue = 0,
const QString &key = QString());
+#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
/**
- * @deprecated
- * Use addItemULongLong().
+ * @deprecated Since 5.0, use addItemULongLong().
*/
-#ifndef KDE_NO_DEPRECATED
- KCONFIGCORE_DEPRECATED ItemULongLong *addItemUInt64(const QString &name, quint64 &reference,
+ KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Use KCoreConfigSkeleton::addItemULongLong(...)")
+ ItemULongLong *addItemUInt64(const QString &name, quint64 &reference,
quint64 defaultValue = 0,
const QString &key = QString());
#endif
@@ -1475,11 +1476,12 @@ public Q_SLOTS:
*/
bool save();
-#ifndef KCONFIGCORE_NO_DEPRECATED
+#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
/**
* @deprecated since 5.0, call save() instead.
*/
- KCONFIGCORE_DEPRECATED void writeConfig()
+ KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Use KCoreConfigSkeleton::save()")
+ void writeConfig()
{
save();
}
@@ -1523,17 +1525,23 @@ protected:
*/
virtual bool usrSave();
+#if KCONFIGCORE_BUILD_DEPRECATED_SINCE(5, 0)
/**
* @deprecated since 5.0, override usrRead instead. This method is still called from usrRead
* for compatibility.
*/
- KCONFIGCORE_DEPRECATED virtual void usrReadConfig();
+ KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Override KCoreConfigSkeleton::usrRead()")
+ virtual void usrReadConfig();
+#endif
+#if KCONFIGCORE_BUILD_DEPRECATED_SINCE(5, 0)
/**
* @deprecated since 5.0, override usrSave instead. This method is still called from usrSave
* for compatibility.
*/
- KCONFIGCORE_DEPRECATED virtual bool usrWriteConfig();
+ KCONFIGCORE_DEPRECATED_VERSION(5, 0, "Override KCoreConfigSkeleton::usrSave()")
+ virtual bool usrWriteConfig();
+#endif
private:
KCoreConfigSkeletonPrivate *const d;