xbmc/settings/ISubSettings.h

   1 /*
   2  *  Copyright (C) 2013-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 class TiXmlNode;
  12
  13 /*!
  14  \ingroup settings
  15  \brief Interface defining methods to load additional setting values from an
  16  XML file being loaded by the settings system.
  17  */
  18 class ISubSettings
  19 {
  20 public:
  21   virtual ~ISubSettings() = default;
  22
  23   /*!
  24    \brief Load settings from the given XML node.
  25
  26    \param settings XML node containing setting values
  27    \return True if loading the settings was successful, false otherwise.
  28    */
  29   virtual bool Load(const TiXmlNode *settings) { return true; }
  30   /*!
  31    \brief Save settings to the given XML node.
  32
  33    \param settings XML node in which the settings will be saved
  34    \return True if saving the settings was successful, false otherwise.
  35    */
  36   virtual bool Save(TiXmlNode *settings) const { return true; }
  37   /*!
  38    \brief Clear any loaded setting values.
  39    */
  40   virtual void Clear() { }
  41 };