blob: fd43743bda7c681fd097f98c96efea20fce6665e (
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
#pragma once
/*
* Copyright (C) 2013 Team XBMC
* http://xbmc.org
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#include <string>
#include <vector>
#include "ISetting.h"
#include "Setting.h"
#include "SettingCategoryAccess.h"
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 = NULL);
~CSettingGroup();
// implementation of ISetting
virtual bool Deserialize(const TiXmlNode *node, bool update = false);
/*!
\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(CSetting *setting);
void AddSettings(const SettingList &settings);
private:
SettingList m_settings;
};
typedef std::vector<CSettingGroup *> SettingGroupList;
/*!
\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 = NULL);
~CSettingCategory();
// implementation of ISetting
virtual bool Deserialize(const TiXmlNode *node, bool update = false);
/*!
\brief Gets the localizeable label ID of the setting category.
\return Localizeable label ID of the setting category
*/
const int GetLabel() const { return m_label; }
/*!
\brief Sets the localizeable label ID of the setting category.
\param label Localizeable label ID of the setting category
*/
void SetLabel(int label) { m_label = label; }
/*!
\brief Gets the localizeable help ID of the setting category.
\return Localizeable help ID of the setting category
*/
const int GetHelp() const { return m_help; }
/*!
\brief Sets the localizeable help ID of the setting category.
\param label Localizeable help ID of the setting category
*/
void SetHelp(int help) { m_help = help; }
/*!
\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(CSettingGroup *group);
void AddGroups(const SettingGroupList &groups);
private:
int m_label;
int m_help;
SettingGroupList m_groups;
CSettingCategoryAccess m_accessCondition;
};
typedef std::vector<CSettingCategory *> SettingCategoryList;
/*!
\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 = NULL);
~CSettingSection();
// implementation of ISetting
virtual bool Deserialize(const TiXmlNode *node, bool update = false);
/*!
\brief Gets the localizeable label ID of the setting section.
\return Localizeable label ID of the setting section
*/
const int GetLabel() const { return m_label; }
/*!
\brief Sets the localizeable label ID of the setting section.
\param label Localizeable label ID of the setting section
*/
void SetLabel(int label) { m_label = label; }
/*!
\brief Gets the localizeable help ID of the setting section.
\return Localizeable help ID of the setting section
*/
const int GetHelp() const { return m_help; }
/*!
\brief Sets the localizeable help ID of the setting section.
\param label Localizeable help ID of the setting section
*/
void SetHelp(int help) { m_help = help; }
/*!
\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(CSettingCategory *category);
void AddCategories(const SettingCategoryList &categories);
private:
int m_label;
int m_help;
SettingCategoryList m_categories;
};
|
