-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__addon__addonbase___defs___c_setting_value.html
342 lines (322 loc) · 18.8 KB
/
group__cpp__kodi__addon__addonbase___defs___c_setting_value.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: class CSettingValue</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__kodi__addon__addonbase___defs___c_setting_value.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">class CSettingValue<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__addon.html">Interface - kodi::addon</a> » <a class="el" href="group__cpp__kodi__addon__addonbase.html">class CAddonBase</a> » <a class="el" href="group__cpp__kodi__addon__addonbase___defs.html">Definitions, structures and enumerators</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>Setting value handler</b><br />
Inside addon main instance used helper class to give settings value. </p>
<p>This is used on <a class="el" href="group__cpp__kodi__addon__addonbase.html#ga1729a597265408b52198edba006e00fd">addon::CAddonBase::SetSetting()</a> to inform addon about settings change by used. This becomes then used to give the related value name.</p>
<hr />
<p><b>The following table contains values that can be set with <a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html">class CSettingValue</a> :</b> </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Name </th><th class="markdownTableHeadNone">Type </th><th class="markdownTableHeadNone">Get call </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Settings value as string</b> </td><td class="markdownTableBodyNone"><code>std::string</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga764f99b38cb3cd18ab87c5261321e063">GetString</a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Settings value as integer</b> </td><td class="markdownTableBodyNone"><code>int</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga3f9636de28d683833247125cd9427046">GetInt</a> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Settings value as unsigned integer</b> </td><td class="markdownTableBodyNone"><code>unsigned int</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga3aa86241f9d3a2905616b393a858b354">GetUInt</a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Settings value as boolean</b> </td><td class="markdownTableBodyNone"><code>bool</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga41c297793cf20f9c7812dc56a68f7ce4">GetBoolean</a> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Settings value as floating point</b> </td><td class="markdownTableBodyNone"><code>float</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#gaa61c6d39394461db44dfd5d01df49a73">GetFloat</a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Settings value as enum</b> </td><td class="markdownTableBodyNone"><code>enum</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#gadd5b4ff49052225ffea10c04c870b5b9">GetEnum</a> </td></tr>
</table>
<hr />
<p><b>Here is a code example how this is used:</b></p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <kodi/AddonBase.h></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">enum</span> myEnumValue</div>
<div class="line">{</div>
<div class="line"> valueA,</div>
<div class="line"> valueB,</div>
<div class="line"> valueC</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line">std::string m_myStringValue;</div>
<div class="line"><span class="keywordtype">int</span> m_myIntegerValue;</div>
<div class="line"><span class="keywordtype">bool</span> m_myBooleanValue;</div>
<div class="line"><span class="keywordtype">float</span> m_myFloatingPointValue;</div>
<div class="line">myEnumValue m_myEnumValue;</div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a> CMyAddon::SetSetting(<span class="keyword">const</span> std::string& settingName, <span class="keyword">const</span> <a class="code" href="classkodi_1_1_c_setting_value.html">kodi::CSettingValue</a>& settingValue)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">if</span> (settingName == <span class="stringliteral">"my_string_value"</span>)</div>
<div class="line"> m_myStringValue = settingValue.<a class="code" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga764f99b38cb3cd18ab87c5261321e063">GetString</a>();</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (settingName == <span class="stringliteral">"my_integer_value"</span>)</div>
<div class="line"> m_myIntegerValue = settingValue.<a class="code" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga3f9636de28d683833247125cd9427046">GetInt</a>();</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (settingName == <span class="stringliteral">"my_boolean_value"</span>)</div>
<div class="line"> m_myBooleanValue = settingValue.<a class="code" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga41c297793cf20f9c7812dc56a68f7ce4">GetBoolean</a>();</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (settingName == <span class="stringliteral">"my_float_value"</span>)</div>
<div class="line"> m_myFloatingPointValue = settingValue.<a class="code" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#gaa61c6d39394461db44dfd5d01df49a73">GetFloat</a>();</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (settingName == <span class="stringliteral">"my_enum_value"</span>)</div>
<div class="line"> m_myEnumValue = settingValue.<a class="code" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#gadd5b4ff49052225ffea10c04c870b5b9">GetEnum</a><myEnumValue>();</div>
<div class="line">}</div>
<div class="ttc" id="aclasskodi_1_1_c_setting_value_html"><div class="ttname"><a href="classkodi_1_1_c_setting_value.html">kodi::CSettingValue</a></div><div class="ttdef"><b>Definition:</b> AddonBase.h:119</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s_html_ga335347495ed00620451a69cfe3494502"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a></div><div class="ttdeci">ADDON_STATUS</div><div class="ttdef"><b>Definition:</b> addon_base.h:128</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___c_setting_value_html_ga3f9636de28d683833247125cd9427046"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga3f9636de28d683833247125cd9427046">kodi::CSettingValue::GetInt</a></div><div class="ttdeci">int GetInt() const</div><div class="ttdoc">To get settings value as integer.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:145</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___c_setting_value_html_ga41c297793cf20f9c7812dc56a68f7ce4"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga41c297793cf20f9c7812dc56a68f7ce4">kodi::CSettingValue::GetBoolean</a></div><div class="ttdeci">bool GetBoolean() const</div><div class="ttdoc">To get settings value as boolean.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:151</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___c_setting_value_html_ga764f99b38cb3cd18ab87c5261321e063"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#ga764f99b38cb3cd18ab87c5261321e063">kodi::CSettingValue::GetString</a></div><div class="ttdeci">std::string GetString() const</div><div class="ttdoc">To get settings value as string.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:142</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___c_setting_value_html_gaa61c6d39394461db44dfd5d01df49a73"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#gaa61c6d39394461db44dfd5d01df49a73">kodi::CSettingValue::GetFloat</a></div><div class="ttdeci">float GetFloat() const</div><div class="ttdoc">To get settings value as floating point.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:154</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___c_setting_value_html_gadd5b4ff49052225ffea10c04c870b5b9"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___c_setting_value.html#gadd5b4ff49052225ffea10c04c870b5b9">kodi::CSettingValue::GetEnum</a></div><div class="ttdeci">enumType GetEnum() const</div><div class="ttdoc">To get settings value as enum.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:159</div></div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>The asked type should match the type used on settings.xml. </dd></dl>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cpp__kodi__addon__addonbase___defs___c_setting_value___help"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__addonbase___defs___c_setting_value___help.html">Value Help</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga764f99b38cb3cd18ab87c5261321e063"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga764f99b38cb3cd18ab87c5261321e063">◆ </a></span>GetString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string GetString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To get settings value as string. </p>
</div>
</div>
<a id="ga3f9636de28d683833247125cd9427046"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f9636de28d683833247125cd9427046">◆ </a></span>GetInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int GetInt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To get settings value as integer. </p>
</div>
</div>
<a id="ga3aa86241f9d3a2905616b393a858b354"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3aa86241f9d3a2905616b393a858b354">◆ </a></span>GetUInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetUInt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To get settings value as unsigned integer. </p>
</div>
</div>
<a id="ga41c297793cf20f9c7812dc56a68f7ce4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga41c297793cf20f9c7812dc56a68f7ce4">◆ </a></span>GetBoolean()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool GetBoolean </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To get settings value as boolean. </p>
</div>
</div>
<a id="gaa61c6d39394461db44dfd5d01df49a73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa61c6d39394461db44dfd5d01df49a73">◆ </a></span>GetFloat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float GetFloat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To get settings value as floating point. </p>
</div>
</div>
<a id="gadd5b4ff49052225ffea10c04c870b5b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd5b4ff49052225ffea10c04c870b5b9">◆ </a></span>GetEnum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enumType GetEnum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To get settings value as enum. </p>
<dl class="section note"><dt>Note</dt><dd>Inside settings.xml them stored as integer. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>