X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsettings.h;h=e9bf28d087da87869c83fc367682de98c00c878e;hp=4f556d79973b862d0373a0d59b581bed5a182535;hb=d2ac8f78a0e050d2efa397c434b249d6b3391576;hpb=84cd3561e97167ffb98ecab0fd2b884ba1d13ada diff --git a/src/common/settings.h b/src/common/settings.h index 4f556d79..e9bf28d0 100644 --- a/src/common/settings.h +++ b/src/common/settings.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2014 by the Quassel Project * + * Copyright (C) 2005-2016 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -53,8 +53,36 @@ public: //! Sets up notification and calls the given slot to set the initial value void initAndNotify(const QString &key, QObject *receiver, const char *slot, const QVariant &defaultValue = QVariant()); + /** + * Get the major configuration version + * + * This indicates the backwards/forwards incompatible version of configuration. + * + * @return Major configuration version (the X in XX.YY) + */ virtual uint version(); + /** + * Get the minor configuration version + * + * This indicates the backwards/forwards compatible version of configuration. + * + * @see Settings::setVersionMinor() + * @return Minor configuration version (the Y in XX.YY) + */ + virtual uint versionMinor(); + + /** + * Set the minor configuration version + * + * When making backwards/forwards compatible changes, call this with the new version number. + * This does not implement any upgrade logic; implement that when checking Settings::version(), + * e.g. in Core::Core() and QtUiApplication::init(). + * + * @param[in] versionMinor New minor version number + */ + virtual void setVersionMinor(const uint versionMinor); + protected: inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {} inline virtual ~Settings() {} @@ -68,6 +96,14 @@ protected: virtual void setLocalValue(const QString &key, const QVariant &data); virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant()); + /** + * Gets if a key exists in settings + * + * @param[in] key ID of local settings key + * @returns True if key exists in settings, otherwise false + */ + virtual bool localKeyExists(const QString &key); + virtual void removeLocalKey(const QString &key); QString group;