ISetting.h

/*
 *  Copyright (C) 2013-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "SettingRequirement.h"

#include <string>

class CSettingsManager;
class TiXmlNode;

class ISetting
{
public:
  ISetting(const std::string &id, CSettingsManager *settingsManager = nullptr);
  virtual ~ISetting() = default;

  virtual bool Deserialize(const TiXmlNode *node, bool update = false);

  const std::string& GetId() const { return m_id; }
  virtual bool IsVisible() const { return m_visible; }
  virtual void SetVisible(bool visible) { m_visible = visible; }
  int GetLabel() const { return m_label; }
  void SetLabel(int label) { m_label = label; }
  int GetHelp() const { return m_help; }
  void SetHelp(int help) { m_help = help; }
  virtual bool MeetsRequirements() const { return m_meetsRequirements; }
  virtual void CheckRequirements();
  virtual void SetRequirementsMet(bool requirementsMet) { m_meetsRequirements = requirementsMet; }

  static bool DeserializeIdentification(const TiXmlNode *node, std::string &identification);

protected:
  static constexpr int DefaultLabel = -1;
  static bool DeserializeIdentificationFromAttribute(const TiXmlNode* node,
                                                     const std::string& attribute,
                                                     std::string& identification);

  std::string m_id;
  CSettingsManager *m_settingsManager;

private:
  bool m_visible = true;
  int m_label = DefaultLabel;
  int m_help = -1;
  bool m_meetsRequirements = true;
  CSettingRequirement m_requirementCondition;
};