From b6d455a02bd338e9dc0faa09d4d8177ecd8d569a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Petr=20Mr=C3=A1zek?= <peterix@gmail.com>
Date: Sun, 10 Apr 2016 15:53:05 +0200
Subject: NOISSUE reorganize and document libraries

---
 api/logic/settings/Setting.h | 119 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 119 insertions(+)
 create mode 100644 api/logic/settings/Setting.h

(limited to 'api/logic/settings/Setting.h')

diff --git a/api/logic/settings/Setting.h b/api/logic/settings/Setting.h
new file mode 100644
index 00000000..6d53ac6d
--- /dev/null
+++ b/api/logic/settings/Setting.h
@@ -0,0 +1,119 @@
+/* Copyright 2013-2015 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <QObject>
+#include <QVariant>
+#include <QStringList>
+#include <memory>
+
+#include "multimc_logic_export.h"
+
+class SettingsObject;
+
+/*!
+ *
+ */
+class MULTIMC_LOGIC_EXPORT Setting : public QObject
+{
+	Q_OBJECT
+public:
+	/**
+	 * Construct a Setting
+	 *
+	 * Synonyms are all the possible names used in the settings object, in order of preference.
+	 * First synonym is the ID, which identifies the setting in MultiMC.
+	 *
+	 * defVal is the default value that will be returned when the settings object
+	 * doesn't have any value for this setting.
+	 */
+	explicit Setting(QStringList synonyms, QVariant defVal = QVariant());
+
+	/*!
+	 * \brief Gets this setting's ID.
+	 * This is used to refer to the setting within the application.
+	 * \warning Changing the ID while the setting is registered with a SettingsObject results in
+	 * undefined behavior.
+	 * \return The ID of the setting.
+	 */
+	virtual QString id() const
+	{
+		return m_synonyms.first();
+	}
+
+	/*!
+	 * \brief Gets this setting's config file key.
+	 * This is used to store the setting's value in the config file. It is usually
+	 * the same as the setting's ID, but it can be different.
+	 * \return The setting's config file key.
+	 */
+	virtual QStringList configKeys() const
+	{
+		return m_synonyms;
+	}
+
+	/*!
+	 * \brief Gets this setting's value as a QVariant.
+	 * This is done by calling the SettingsObject's retrieveValue() function.
+	 * If this Setting doesn't have a SettingsObject, this returns an invalid QVariant.
+	 * \return QVariant containing this setting's value.
+	 * \sa value()
+	 */
+	virtual QVariant get() const;
+
+	/*!
+	 * \brief Gets this setting's default value.
+	 * \return The default value of this setting.
+	 */
+	virtual QVariant defValue() const;
+
+signals:
+	/*!
+	 * \brief Signal emitted when this Setting object's value changes.
+	 * \param setting A reference to the Setting that changed.
+	 * \param value This Setting object's new value.
+	 */
+	void SettingChanged(const Setting &setting, QVariant value);
+
+	/*!
+	 * \brief Signal emitted when this Setting object's value resets to default.
+	 * \param setting A reference to the Setting that changed.
+	 */
+	void settingReset(const Setting &setting);
+
+public
+slots:
+	/*!
+	 * \brief Changes the setting's value.
+	 * This is done by emitting the SettingChanged() signal which will then be
+	 * handled by the SettingsObject object and cause the setting to change.
+	 * \param value The new value.
+	 */
+	virtual void set(QVariant value);
+
+	/*!
+	 * \brief Reset the setting to default
+	 * This is done by emitting the settingReset() signal which will then be
+	 * handled by the SettingsObject object and cause the setting to change.
+	 */
+	virtual void reset();
+
+protected:
+	friend class SettingsObject;
+	SettingsObject * m_storage;
+	QStringList m_synonyms;
+	QVariant m_defVal;
+};
-- 
cgit v1.2.3