-
Notifications
You must be signed in to change notification settings - Fork 1
/
_fade__label__control.html
183 lines (181 loc) · 11.2 KB
/
_fade__label__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
<!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: Fade label 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('_fade__label__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">Fade label control </div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#Fade_Label_Control_sect1">Example</a></li>
<li class="level1"><a href="#Fade_Label_Control_sect2">Tag descriptions</a></li>
<li class="level1"><a href="#Fade_Label_Control_sect3">See also</a></li>
</ul>
</div>
<div class="textblock"><p><b>Used to show multiple pieces of text in the same position, by fading from one to the other.</b></p>
<p>The fade label control is used for displaying multiple pieces of text in the same space in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed. The first piece of information to display fades in over 50 frames, then scrolls off to the left. Once it is finished scrolling off screen, the second piece of information fades in and the process repeats. A fade label control is not supported in a list container.</p>
<hr />
<h1><a class="anchor" id="Fade_Label_Control_sect1"></a>
Example</h1>
<div class="fragment"><div class="line"><control type=<span class="stringliteral">"fadelabel"</span> <span class="keywordtype">id</span>=<span class="stringliteral">"1"</span>></div>
<div class="line"> <description>My First fadelabel</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"> <visible><span class="keyword">true</span></visible></div>
<div class="line"> <scrollout><span class="keyword">true</span></scrollout></div>
<div class="line"> <pauseatend>200</pauseatend></div>
<div class="line"> <label>6</label></div>
<div class="line"> <info>MusicPlayer.Genre</info></div>
<div class="line"> <info>MusicPlayer.Artist</info></div>
<div class="line"> <info>MusicPlayer.Album</info></div>
<div class="line"> <info>MusicPlayer.Year</info></div>
<div class="line"> <font>font14</font></div>
<div class="line"> <textcolor>FFB2D4F5</textcolor></div>
<div class="line"> <textoffsetx>20</textoffsetx></div>
<div class="line"> <scroll><span class="keyword">true</span></scroll></div>
<div class="line"> <randomize><span class="keyword">true</span></randomize></div>
<div class="line"></control></div>
</div><!-- fragment --><hr />
<h1><a class="anchor" id="Fade_Label_Control_sect2"></a>
Tag descriptions</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">label </td><td class="markdownTableBodyLeft">Specifies the text which should be drawn. You should specify an entry from the strings.po here, however you may also specify a piece of text yourself if you wish, though of course it will not be localisable. <a href="http://kodi.wiki/view/Label_Parsing">You may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats</a>. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">info </td><td class="markdownTableBodyLeft">Specifies the information that should be presented. Kodi will auto-fill in this info in place of the <b><code><label></code></b>. <a href="http://kodi.wiki/view/InfoLabels">See here for more information</a>. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">font </td><td class="markdownTableBodyLeft">Specifies the font to use from the font.xml file. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">textcolor </td><td class="markdownTableBodyLeft">Specified the color the text should be, in hex <b>AARRGGBB</b> 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">textoffsetx </td><td class="markdownTableBodyLeft">Specify the offset from the left edge that the text should be rendered at when static (not scrolling). The scrolling text will still scroll using the full <b><code><width></code></b> of the control. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">shadowcolor </td><td class="markdownTableBodyLeft">Specifies the color of the drop shadow on the text, in <b>AARRGGBB</b> 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">angle </td><td class="markdownTableBodyLeft">Specifies the angle at which the text should be drawn, measured counter clockwise from the horizontal. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">scrollout </td><td class="markdownTableBodyLeft">If set to False the fadelabel will only scroll until the last char is to the right side of the width of the fadelabel instead of all the way out to the left. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">pauseatend </td><td class="markdownTableBodyLeft">Specifies the time that the text will wait until it fades away before it scrolls again or moves to the next item. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">resetonlabelchange </td><td class="markdownTableBodyLeft">If set to false the fadelabel will not reset the scrolling offset when the label's content changes. Useful if you have things such as the play time (in seconds) inside a fadelabel. Defaults to true. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">scrollspeed </td><td class="markdownTableBodyLeft">Scroll speed of text in pixels per second. Defaults to 60. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">scroll </td><td class="markdownTableBodyLeft">If set to false, the labels won't scroll. Defaults to true. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">randomize </td><td class="markdownTableBodyLeft">If set to true, the labels will be displayed in a random order. Defaults to false. </td></tr>
</table>
<hr />
<h1><a class="anchor" id="Fade_Label_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>