NOISSUE reorganize and document libraries

1 files changed, 46 insertions, 0 deletions

diff --git a/api/logic/settings/OverrideSetting.h b/api/logic/settings/OverrideSetting.h
new file mode 100644
index 00000000..68595cde
--- /dev/null
+++ b/api/logic/settings/OverrideSetting.h
@@ -0,0 +1,46 @@
+/* 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 <memory>
+
+#include "Setting.h"
+
+/*!
+ * \brief A setting that 'overrides another.'
+ * This means that the setting's default value will be the value of another setting.
+ * The other setting can be (and usually is) a part of a different SettingsObject
+ * than this one.
+ */
+class OverrideSetting : public Setting
+{
+	Q_OBJECT
+public:
+	explicit OverrideSetting(std::shared_ptr<Setting> overriden, std::shared_ptr<Setting> gate);
+
+	virtual QVariant defValue() const;
+	virtual QVariant get() const;
+	virtual void set (QVariant value);
+	virtual void reset();
+
+private:
+	bool isOverriding() const;
+
+protected:
+	std::shared_ptr<Setting> m_other;
+	std::shared_ptr<Setting> m_gate;
+};