/***************************************************************************
- * Copyright (C) 2005-09 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 *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef SETTINGS_H
#include "quassel.h"
-class SettingsChangeNotifier : public QObject {
- Q_OBJECT
+class SettingsChangeNotifier : public QObject
+{
+ Q_OBJECT
signals:
- void valueChanged(const QVariant &newValue);
+ void valueChanged(const QVariant &newValue);
private:
- friend class Settings;
+ friend class Settings;
};
-class Settings {
-public:
- enum Mode { Default, Custom };
+class Settings
+{
public:
- //! Call the given slot on change of the given key
- virtual void notify(const QString &key, QObject *receiver, const char *slot);
-
- //! 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());
+ enum Mode { Default, Custom };
- virtual uint version();
+public:
+ //! Call the given slot on change of the given key
+ virtual void notify(const QString &key, QObject *receiver, const char *slot);
+
+ //! 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);
+
+ /**
+ * Persist unsaved changes to permanent storage
+ *
+ * @return true if succeeded, false otherwise
+ */
+ bool sync();
+
+ /**
+ * Check if the configuration storage is writable.
+ *
+ * @return true if writable, false otherwise
+ */
+ bool isWritable();
protected:
- inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {}
- inline virtual ~Settings() {}
+ inline Settings(QString group_, QString appName_) : group(group_), appName(appName_) {}
+ inline virtual ~Settings() {}
- inline void setGroup(const QString &group_) { group = group_; }
+ inline void setGroup(const QString &group_) { group = group_; }
- virtual QStringList allLocalKeys();
- virtual QStringList localChildKeys(const QString &rootkey = QString());
- virtual QStringList localChildGroups(const QString &rootkey = QString());
+ virtual QStringList allLocalKeys();
+ virtual QStringList localChildKeys(const QString &rootkey = QString());
+ virtual QStringList localChildGroups(const QString &rootkey = QString());
- virtual void setLocalValue(const QString &key, const QVariant &data);
- virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant());
+ virtual void setLocalValue(const QString &key, const QVariant &data);
+ virtual const QVariant &localValue(const QString &key, const QVariant &def = QVariant());
- virtual void removeLocalKey(const QString &key);
+ /**
+ * 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);
- QString group;
- QString appName;
+ virtual void removeLocalKey(const QString &key);
+
+ QString group;
+ QString appName;
private:
- inline QSettings::Format format() {
-#ifdef Q_WS_WIN
- return QSettings::IniFormat;
+ inline QSettings::Format format()
+ {
+#ifdef Q_OS_WIN
+ return QSettings::IniFormat;
#else
- return QSettings::NativeFormat;
+ return QSettings::NativeFormat;
#endif
- }
- inline QString fileName() {
- return Quassel::configDirPath() + appName
- + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
- }
-
- static QHash<QString, QVariant> settingsCache;
- static QHash<QString, SettingsChangeNotifier *> settingsChangeNotifier;
-
- inline QString normalizedKey(const QString &group, const QString &key) {
- if(group.isEmpty())
- return key;
- return group + '/' + key;
- }
-
- inline void setCacheValue(const QString &normKey, const QVariant &data) {
- settingsCache[normKey] = data;
- }
- inline const QVariant &cacheValue(const QString &normKey) {
- return settingsCache[normKey];
- }
- inline bool isCached(const QString &normKey) {
- return settingsCache.contains(normKey);
- }
-
- inline SettingsChangeNotifier *notifier(const QString &normKey) {
- if(!hasNotifier(normKey))
- settingsChangeNotifier[normKey] = new SettingsChangeNotifier();
- return settingsChangeNotifier[normKey];
- }
-
- inline bool hasNotifier(const QString &normKey) {
- return settingsChangeNotifier.contains(normKey);
- }
+ }
+
+
+ inline QString fileName()
+ {
+ return Quassel::configDirPath() + appName
+ + ((format() == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
+ }
+
+
+ static QHash<QString, QVariant> settingsCache;
+ static QHash<QString, SettingsChangeNotifier *> settingsChangeNotifier;
+
+ inline QString normalizedKey(const QString &group, const QString &key)
+ {
+ if (group.isEmpty())
+ return key;
+ return group + '/' + key;
+ }
+
+
+ inline void setCacheValue(const QString &normKey, const QVariant &data)
+ {
+ settingsCache[normKey] = data;
+ }
+
+
+ inline const QVariant &cacheValue(const QString &normKey)
+ {
+ return settingsCache[normKey];
+ }
+
+
+ inline bool isCached(const QString &normKey)
+ {
+ return settingsCache.contains(normKey);
+ }
+
+
+ inline SettingsChangeNotifier *notifier(const QString &normKey)
+ {
+ if (!hasNotifier(normKey))
+ settingsChangeNotifier[normKey] = new SettingsChangeNotifier();
+ return settingsChangeNotifier[normKey];
+ }
+
+
+ inline bool hasNotifier(const QString &normKey)
+ {
+ return settingsChangeNotifier.contains(normKey);
+ }
};
+
#endif
projects / quassel.git / blobdiff