blob: f8e06d6ab58e1db63309b17e9f6ecaed37d437d6 (
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
* 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 "ISetting.h"
#include "Setting.h"
#include "SettingCategoryAccess.h"
#include "utils/logtypes.h"
#include <string>
#include <utility>
#include <vector>
class CSettingsManager;
/*!
\ingroup settings
\brief Group of settings being part of a category
\sa CSettingCategory
\sa CSetting
*/
class CSettingGroup : public ISetting
{
public:
/*!
\brief Creates a new setting group with the given identifier.
\param id Identifier of the setting group
\param settingsManager Reference to the settings manager
*/
CSettingGroup(const std::string &id, CSettingsManager *settingsManager = nullptr);
~CSettingGroup() override = default;
// implementation of ISetting
bool Deserialize(const TiXmlNode *node, bool update = false) override;
/*!
\brief Gets the full list of settings belonging to the setting group.
\return Full list of settings belonging to the setting group
*/
const SettingList& GetSettings() const { return m_settings; }
/*!
\brief Gets the list of settings assigned to the given setting level (or
below) and that meet the requirements conditions belonging to the setting
group.
\param level Level the settings should be assigned to
\return List of settings belonging to the setting group
*/
SettingList GetSettings(SettingLevel level) const;
void AddSetting(const std::shared_ptr<CSetting>& setting);
void AddSettings(const SettingList &settings);
bool ReplaceSetting(const std::shared_ptr<const CSetting>& currentSetting,
const std::shared_ptr<CSetting>& newSetting);
std::shared_ptr<const ISettingControl> GetControl() const { return m_control; }
std::shared_ptr<ISettingControl> GetControl() { return m_control; }
void SetControl(std::shared_ptr<ISettingControl> control) { m_control = std::move(control); }
private:
SettingList m_settings;
std::shared_ptr<ISettingControl> m_control;
static Logger s_logger;
};
using SettingGroupPtr = std::shared_ptr<CSettingGroup>;
using SettingGroupList = std::vector<SettingGroupPtr>;
/*!
\ingroup settings
\brief Category of groups of settings being part of a section
\sa CSettingSection
\sa CSettingGroup
*/
class CSettingCategory : public ISetting
{
public:
/*!
\brief Creates a new setting category with the given identifier.
\param id Identifier of the setting category
\param settingsManager Reference to the settings manager
*/
CSettingCategory(const std::string &id, CSettingsManager *settingsManager = nullptr);
~CSettingCategory() override = default;
// implementation of ISetting
bool Deserialize(const TiXmlNode *node, bool update = false) override;
/*!
\brief Gets the full list of setting groups belonging to the setting
category.
\return Full list of setting groups belonging to the setting category
*/
const SettingGroupList& GetGroups() const { return m_groups; }
/*!
\brief Gets the list of setting groups belonging to the setting category
that contain settings assigned to the given setting level (or below) and
that meet the requirements and visibility conditions.
\param level Level the settings should be assigned to
\return List of setting groups belonging to the setting category
*/
SettingGroupList GetGroups(SettingLevel level) const;
/*!
\brief Whether the setting category can be accessed or not.
\return True if the setting category can be accessed, false otherwise
*/
bool CanAccess() const;
void AddGroup(const SettingGroupPtr& group);
void AddGroupToFront(const SettingGroupPtr& group);
void AddGroups(const SettingGroupList &groups);
private:
SettingGroupList m_groups;
CSettingCategoryAccess m_accessCondition;
static Logger s_logger;
};
using SettingCategoryPtr = std::shared_ptr<CSettingCategory>;
using SettingCategoryList = std::vector<SettingCategoryPtr>;
/*!
\ingroup settings
\brief Section of setting categories
\sa CSettings
\sa CSettingCategory
*/
class CSettingSection : public ISetting
{
public:
/*!
\brief Creates a new setting section with the given identifier.
\param id Identifier of the setting section
\param settingsManager Reference to the settings manager
*/
CSettingSection(const std::string &id, CSettingsManager *settingsManager = nullptr);
~CSettingSection() override = default;
// implementation of ISetting
bool Deserialize(const TiXmlNode *node, bool update = false) override;
/*!
\brief Gets the full list of setting categories belonging to the setting
section.
\return Full list of setting categories belonging to the setting section
*/
const SettingCategoryList& GetCategories() const { return m_categories; }
/*!
\brief Gets the list of setting categories belonging to the setting section
that contain settings assigned to the given setting level (or below) and
that meet the requirements and visibility conditions.
\param level Level the settings should be assigned to
\return List of setting categories belonging to the setting section
*/
SettingCategoryList GetCategories(SettingLevel level) const;
void AddCategory(const SettingCategoryPtr& category);
void AddCategories(const SettingCategoryList &categories);
private:
SettingCategoryList m_categories;
static Logger s_logger;
};
using SettingSectionPtr = std::shared_ptr<CSettingSection>;
using SettingSectionList = std::vector<SettingSectionPtr>;
|
