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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
|
/*
* Copyright (C) 2017-2021 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 "commons/Exception.h"
#include "interfaces/legacy/AddonClass.h"
#include "interfaces/legacy/AddonString.h"
#include "interfaces/legacy/Exception.h"
#include "interfaces/legacy/Tuple.h"
#include "settings/lib/SettingDefinitions.h"
#include <memory>
#include <string>
#include <vector>
class CSettingsBase;
namespace XBMCAddon
{
namespace xbmcaddon
{
XBMCCOMMONS_STANDARD_EXCEPTION(SettingCallbacksNotSupportedException);
//
/// \defgroup python_settings Settings
/// \ingroup python_xbmcaddon
/// @{
/// @brief **Add-on settings**
///
/// \python_class{ Settings() }
///
/// This wrapper provides access to the settings specific to an add-on.
/// It supports reading and writing specific setting values.
///
///-----------------------------------------------------------------------
/// @python_v20 New class added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// settings = xbmcaddon.Addon('id').getSettings()
/// ...
/// ~~~~~~~~~~~~~
//
class Settings : public AddonClass
{
public:
#if !defined SWIG && !defined DOXYGEN_SHOULD_SKIP_THIS
std::shared_ptr<CSettingsBase> settings;
#endif
#ifndef SWIG
Settings(std::shared_ptr<CSettingsBase> settings);
#endif
virtual ~Settings() = default;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getBool(id) }
/// Returns the value of a setting as a boolean.
///
/// @param id string - id of the setting that the module needs to access.
/// @return bool - Setting as a boolean
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// enabled = settings.getBool('enabled')
/// ..
/// ~~~~~~~~~~~~~
///
getBool(...);
#else
bool getBool(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getInt(id) }
/// Returns the value of a setting as an integer.
///
/// @param id string - id of the setting that the module needs to access.
/// @return integer - Setting as an integer
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// max = settings.getInt('max')
/// ..
/// ~~~~~~~~~~~~~
///
getInt(...);
#else
int getInt(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getNumber(id) }
/// Returns the value of a setting as a floating point number.
///
/// @param id string - id of the setting that the module needs to access.
/// @return float - Setting as a floating point number
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// max = settings.getNumber('max')
/// ..
/// ~~~~~~~~~~~~~
///
getNumber(...);
#else
double getNumber(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getString(id) }
/// Returns the value of a setting as a unicode string.
///
/// @param id string - id of the setting that the module needs to access.
/// @return string - Setting as a unicode string
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// apikey = settings.getString('apikey')
/// ..
/// ~~~~~~~~~~~~~
///
getString(...);
#else
String getString(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getBoolList(id) }
/// Returns the value of a setting as a list of booleans.
///
/// @param id string - id of the setting that the module needs to access.
/// @return list - Setting as a list of booleans
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// enabled = settings.getBoolList('enabled')
/// ..
/// ~~~~~~~~~~~~~
///
getBoolList(...);
#else
std::vector<bool> getBoolList(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getIntList(id) }
/// Returns the value of a setting as a list of integers.
///
/// @param id string - id of the setting that the module needs to access.
/// @return list - Setting as a list of integers
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// ids = settings.getIntList('ids')
/// ..
/// ~~~~~~~~~~~~~
///
getIntList(...);
#else
std::vector<int> getIntList(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getNumberList(id) }
/// Returns the value of a setting as a list of floating point numbers.
///
/// @param id string - id of the setting that the module needs to access.
/// @return list - Setting as a list of floating point numbers
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// max = settings.getNumberList('max')
/// ..
/// ~~~~~~~~~~~~~
///
getNumberList(...);
#else
std::vector<double> getNumberList(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ getStringList(id) }
/// Returns the value of a setting as a list of unicode strings.
///
/// @param id string - id of the setting that the module needs to access.
/// @return list - Setting as a list of unicode strings
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// views = settings.getStringList('views')
/// ..
/// ~~~~~~~~~~~~~
///
getStringList(...);
#else
std::vector<String> getStringList(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setBool(id, value) }
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param value bool - value of the setting.
/// @return bool - True if the value of the setting was set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setBool(id='enabled', value=True)
/// ..
/// ~~~~~~~~~~~~~
///
setBool(...);
#else
void setBool(const char* id, bool value);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setInt(id, value) }
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param value integer - value of the setting.
/// @return bool - True if the value of the setting was set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setInt(id='max', value=5)
/// ..
/// ~~~~~~~~~~~~~
///
setInt(...);
#else
void setInt(const char* id, int value);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setNumber(id, value) }
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param value float - value of the setting.
/// @return bool - True if the value of the setting was set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setNumber(id='max', value=5.5)
/// ..
/// ~~~~~~~~~~~~~
///
setNumber(...);
#else
void setNumber(const char* id, double value);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setString(id, value) }
/// Sets the value of a setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param value string or unicode - value of the setting.
/// @return bool - True if the value of the setting was set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setString(id='username', value='teamkodi')
/// ..
/// ~~~~~~~~~~~~~
///
setString(...);
#else
void setString(const char* id, const String& value);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setBoolList(id, values) }
/// Sets the boolean values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param values list of boolean - values of the setting.
/// @return bool - True if the values of the setting were set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setBoolList(id='enabled', values=[ True, False ])
/// ..
/// ~~~~~~~~~~~~~
///
setBoolList(...);
#else
void setBoolList(const char* id, const std::vector<bool>& values);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setIntList(id, value) }
/// Sets the integer values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param values list of int - values of the setting.
/// @return bool - True if the values of the setting were set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setIntList(id='max', values=[ 5, 23 ])
/// ..
/// ~~~~~~~~~~~~~
///
setIntList(...);
#else
void setIntList(const char* id, const std::vector<int>& values);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setNumberList(id, value) }
/// Sets the floating point values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param values list of float - values of the setting.
/// @return bool - True if the values of the setting were set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setNumberList(id='max', values=[ 5.5, 5.8 ])
/// ..
/// ~~~~~~~~~~~~~
///
setNumberList(...);
#else
void setNumberList(const char* id, const std::vector<double>& values);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_settings
/// @brief \python_func{ setStringList(id, value) }
/// Sets the string values of a list setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param values list of string or unicode - values of the setting.
/// @return bool - True if the values of the setting were set, false otherwise
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// settings.setStringList(id='username', values=[ 'team', 'kodi' ])
/// ..
/// ~~~~~~~~~~~~~
///
setStringList(...);
#else
void setStringList(const char* id, const std::vector<String>& values);
#endif
};
//@}
} // namespace xbmcaddon
} // namespace XBMCAddon
|
