-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path_settings__spin__control.html
216 lines (214 loc) · 14.2 KB
/
_settings__spin__control.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
<!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: Settings Spin Control</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('_settings__spin__control.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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Settings Spin Control </div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#Settings_Spin_Control_sect1">Example</a></li>
<li class="level1"><a href="#Settings_Spin_Control_sect2">Available tags</a></li>
<li class="level1"><a href="#Settings_Spin_Control_sect3">See also</a></li>
</ul>
</div>
<div class="textblock"><p><b>Used for cycling up/down controls in the settings menus.</b></p>
<p>The settings spin control is used in the settings screens for when a list of options can be chosen from using up/down arrows. You can choose the position, size, and look of the spin control. It is basically a cross between the button control and a spin control. It has a label and focus and non focus textures, as well as a spin control on the right.</p>
<hr />
<h1><a class="anchor" id="Settings_Spin_Control_sect1"></a>
Example</h1>
<div class="fragment"><div class="line"><control type=<span class="stringliteral">"spincontrolex"</span> <span class="keywordtype">id</span>=<span class="stringliteral">"12"</span>></div>
<div class="line"> <description>My first settings spin control</description></div>
<div class="line"> <posx>80</posx></div>
<div class="line"> <posy>60</posy></div>
<div class="line"> <width>250</width></div>
<div class="line"> <height>200</height></div>
<div class="line"> <spinposx>220</spinposx></div>
<div class="line"> <spinposy>180</spinposy></div>
<div class="line"> <spinwidth>16</spinwidth></div>
<div class="line"> <spinheight>16</spinheight></div>
<div class="line"> <visible><span class="keyword">true</span></visible></div>
<div class="line"> <colordiffuse>FFFFFFFF</colordiffuse></div>
<div class="line"> <texturefocus>myfocustexture.png</texturefocus></div>
<div class="line"> <texturenofocus>mynofocustexture.png</texturenofocus></div>
<div class="line"> <textureup>myuptexture.png</textureup></div>
<div class="line"> <textureupfocus>myupfocustexture.png</textureupfocus></div>
<div class="line"> <texturedown>mydowntexture.png</texturedown></div>
<div class="line"> <texturedownfocus>mydownfocustexture.png</texturedownfocus></div>
<div class="line"> <textureupdisabled colordiffuse=<span class="stringliteral">"AAFFAAFF"</span>>mydowntexture.png</textureupdisabled></div>
<div class="line"> <texturedowndisabled colordiffuse=<span class="stringliteral">"AAFFAAFF"</span>>mydownfocustexture.png</texturedowndisabled></div>
<div class="line"> <label>46</label></div>
<div class="line"> <font>font12</font></div>
<div class="line"> <textcolor>FFFFFFFF</textcolor></div>
<div class="line"> <disabledcolor>80FFFFFF</disabledcolor></div>
<div class="line"> <align></align></div>
<div class="line"> <aligny></aligny></div>
<div class="line"> <textoffsetx></textoffsetx></div>
<div class="line"> <textoffsety></textoffsety></div>
<div class="line"> <pulseonselect></pulseonselect></div>
<div class="line"> <onup>2</onup></div>
<div class="line"> <ondown>3</ondown></div>
<div class="line"> <onleft>1</onleft></div>
<div class="line"> <onright>1</onright></div>
<div class="line"></control></div>
</div><!-- fragment --><hr />
<h1><a class="anchor" id="Settings_Spin_Control_sect2"></a>
Available tags</h1>
<p>In addition to the <a href="http://kodi.wiki/view/Default_Control_Tags">Default Control Tags</a> the following tags are available. Note that each tag is <b>lower case</b> only. This is important, as <code>xml</code> tags are case-sensitive.</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadRight">Tag </th><th class="markdownTableHeadLeft">Description </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">spinposx </td><td class="markdownTableBodyLeft">The horizontal position of the spin control for multipage lists. This is offset from the top left of the list. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">spinposy </td><td class="markdownTableBodyLeft">The vertical position of the spin control for multipage lists. This is offset from the top left of the list. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">spinwidth </td><td class="markdownTableBodyLeft">The width of one of the spin control buttons. The textures for this spin control will be scaled to fit this width. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">spinheight </td><td class="markdownTableBodyLeft">The height of one of the spin control buttons. The textures for this spin control will be scaled to fit this height. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">texturefocus </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the control when it has focus. <a href="http://kodi.wiki/view/Texture_Attributes">See here for additional information about textures</a>. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">texturenofocus </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the control when it doesn't focus. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">textureup </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the up arrow when it doesn't have focus. It is displayed to the left of the down arrow. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">textureupfocus </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the up arrow when it has focus. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">textureupdisabled </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the up arrow when the button is disabled. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">texturedown </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the down arrow when it is not focused. It is displayed to the right of the up arrow so that it's right edge is <b><code><textoffsetx></code></b> pixels away from the right edge of the control. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">texturedownfocus </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the down arrow when it has focus. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">texturedowndisabled </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed for the up arrow when the button is disabled. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">label </td><td class="markdownTableBodyLeft">Either a numeric reference into strings.po (for localization), or a string that will be shown on the left of the control. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">font </td><td class="markdownTableBodyLeft">Font used for the controls label. From fonts.xml. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">textcolor </td><td class="markdownTableBodyLeft">Color used for displaying the label. In <b>AARRGGBB</b> hex format, or a name from the <a href="http://kodi.wiki/view/Colour_Themes">colour theme</a>. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">disabledcolor </td><td class="markdownTableBodyLeft">Color used for the label if the control is disabled. In <b>AARRGGBB</b> hex format, or a name from the <a href="http://kodi.wiki/view/Colour_Themes">colour theme</a>. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">shadowcolor </td><td class="markdownTableBodyLeft">Specifies the color of the drop shadow on the text. In <b>AARRGGBB</b> hex format, or a name from the <a href="http://kodi.wiki/view/Colour_Themes">colour theme</a>. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">align </td><td class="markdownTableBodyLeft">Label horizontal alignment on the control. Defaults to left. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">aligny </td><td class="markdownTableBodyLeft">Label vertical alignment on the control. Defaults to top, can also be center. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">textoffsetx </td><td class="markdownTableBodyLeft">Amount to offset the label from the left (or right) edge of the button when using left or right alignment. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">textoffsety </td><td class="markdownTableBodyLeft">Amount to offset the label from the top edge of the button when using top alignment. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">textwidth </td><td class="markdownTableBodyLeft">Will truncate any text that's too long. </td></tr>
</table>
<hr />
<h1><a class="anchor" id="Settings_Spin_Control_sect3"></a>
See also</h1>
<h4>Development:</h4>
<ul>
<li><a href="http://kodi.wiki/view/Add-on_development">Add-on development</a></li>
<li><a href="http://kodi.wiki/view/Skinning">Skinning</a> </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</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>