code.vuplus.com Git - vuplus_xbmc/blob - xbmc/settings/lib/ISettingsHandler.h

   1 #pragma once
   2 /*
   3  *      Copyright (C) 2013 Team XBMC
   4  *      http://xbmc.org
   5  *
   6  *  This Program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This Program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with XBMC; see the file COPYING.  If not, see
  18  *  <http://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 /*!
  23  \ingroup settings
  24  \brief Interface defining methods being called by the settings system if an
  25  action is performed on multiple/all settings
  26  */
  27 class ISettingsHandler
  28 {
  29 public:
  30   virtual ~ISettingsHandler() { }
  31
  32   /*!
  33    \brief Settings loading has been initiated.
  34
  35    \return True if the settings should be loaded, false if the loading should be aborted.
  36    */
  37   virtual bool OnSettingsLoading() { return true; }
  38   /*!
  39    \brief Settings have been loaded.
  40
  41    This callback can be used to trigger loading other settings.
  42    */
  43   virtual void OnSettingsLoaded() { }
  44   /*!
  45    \brief Settings saving has been initiated.
  46
  47    \return True if the settings should be saved, false if the saving should be aborted.
  48    */
  49   virtual bool OnSettingsSaving() const { return true; }
  50   /*!
  51    \brief Settings have been saved.
  52
  53    This callback can be used to trigger saving other settings.
  54    */
  55   virtual void OnSettingsSaved() const { }
  56   /*!
  57    \brief Setting values have been unloaded.
  58
  59    This callback can be used to trigger uninitializing any state variables
  60    (e.g. before re-loading the settings).
  61    */
  62   virtual void OnSettingsUnloaded() { }
  63   /*!
  64    \brief Settings have been cleared.
  65
  66    This callback can be used to trigger clearing any state variables.
  67    */
  68   virtual void OnSettingsCleared() { }
  69 };