blob: 466b55af65b958fb70ce425358b6f6d951f4f03f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
/*
* 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
/*!
\ingroup settings
\brief Interface defining methods being called by the settings system if an
action is performed on multiple/all settings
*/
class ISettingsHandler
{
public:
virtual ~ISettingsHandler() = default;
/*!
\brief Settings loading has been initiated.
\return True if the settings should be loaded, false if the loading should be aborted.
*/
virtual bool OnSettingsLoading() { return true; }
/*!
\brief Settings have been loaded.
This callback can be used to trigger loading other settings.
*/
virtual void OnSettingsLoaded() { }
/*!
\brief Settings saving has been initiated.
\return True if the settings should be saved, false if the saving should be aborted.
*/
virtual bool OnSettingsSaving() const { return true; }
/*!
\brief Settings have been saved.
This callback can be used to trigger saving other settings.
*/
virtual void OnSettingsSaved() const { }
/*!
\brief Setting values have been unloaded.
This callback can be used to trigger uninitializing any state variables
(e.g. before re-loading the settings).
*/
virtual void OnSettingsUnloaded() { }
/*!
\brief Settings have been cleared.
This callback can be used to trigger clearing any state variables.
*/
virtual void OnSettingsCleared() { }
};
|
