Text Box: Difference between revisions
Jump to navigation
Jump to search
m (formatting) |
|||
Line 2: | Line 2: | ||
The text box is used for showing a large multipage piece of text in XBMC. You can choose the position, size, and look of the text. | The text box is used for showing a large multipage piece of text in XBMC. You can choose the position, size, and look of the text. | ||
=== Example === | === Example === | ||
< | <syntaxhighlight lang="XML" enclose="DIV"> | ||
<control type="textbox" id="2"> | <control type="textbox" id="2"> | ||
<description>My first text box control</description> | |||
<posx>80</posx> | |||
<posy>60</posy> | |||
<width>250</width> | |||
<height>200</height> | |||
<visible>true</visible> | |||
<colordiffuse>FFFFFFFF</colordiffuse> | |||
<font>font13</font> | |||
<textcolor>FFFFFFFF</textcolor> | |||
<pulseonselect></pulseonselect> | |||
<pagecontrol>13</pagecontrol> | |||
<autoscroll delay="3000" time="1000" repeat="10000">!Control.HasFocus(13)</autoscroll> | |||
<label>Text to display goes here [CR] next line...</label> | |||
</control> | </control> | ||
</ | </syntaxhighlight> | ||
=== Available | === Available tags === | ||
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive. | In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive. | ||
{| class="wikitable" | {| class="wikitable" | ||
! Tag !! Description | |||
|- | |- | ||
| | | '''height''' | ||
| | | <height>auto</height> is supported in textbox controls | ||
|- | |- | ||
| | | '''font''' | ||
| | | Font used for the items first label. From fonts.xml. | ||
|- | |- | ||
| | | '''textcolor''' | ||
| | | Color used for displaying the text. In AARRGGBB hex format, or a name from the [[Colour Themes|colour theme.]] | ||
|- | |- | ||
| | | '''shadowcolor''' | ||
| | | Specifies the color of the drop shadow on the text. In AARRGGBB format, or a name from the [[Colour Themes|colour theme.]] | ||
|- | |- | ||
| | | '''pagecontrol''' | ||
| | | Specifies the <id> of the page control used to control this textbox. The page control can either be a [[Spin Control]] or a [[Scroll Bar Control]]. | ||
|- | |- | ||
| | | '''autoscroll''' | ||
| | | Specifies the timing and conditions of any autoscrolling this textbox should have. Times are in milliseconds. The content is delayed for the given delay, then scrolls at a rate of one line per time interval until the end. If the repeat tag is present, it then delays for the repeat time, fades out over 1 second, and repeats. It does not wrap or reset to the top at the end of the scroll. You can use any [[List of Boolean Conditions|bool condition]] to specify when autoscrolling should be allowed. | ||
|} | |} | ||
Revision as of 09:15, 12 March 2014
The text box is used for showing a large multipage piece of text in XBMC. You can choose the position, size, and look of the text.
Example
<control type="textbox" id="2"> <description>My first text box control</description> <posx>80</posx> <posy>60</posy> <width>250</width> <height>200</height> <visible>true</visible> <colordiffuse>FFFFFFFF</colordiffuse> <font>font13</font> <textcolor>FFFFFFFF</textcolor> <pulseonselect></pulseonselect> <pagecontrol>13</pagecontrol> <autoscroll delay="3000" time="1000" repeat="10000">!Control.HasFocus(13)</autoscroll> <label>Text to display goes here [CR] next line...</label> </control>
Available tags
In addition to the Default Control Tags the following tags are available. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.
Tag | Description |
---|---|
height | <height>auto</height> is supported in textbox controls |
font | Font used for the items first label. From fonts.xml. |
textcolor | Color used for displaying the text. In AARRGGBB hex format, or a name from the colour theme. |
shadowcolor | Specifies the color of the drop shadow on the text. In AARRGGBB format, or a name from the colour theme. |
pagecontrol | Specifies the <id> of the page control used to control this textbox. The page control can either be a Spin Control or a Scroll Bar Control. |
autoscroll | Specifies the timing and conditions of any autoscrolling this textbox should have. Times are in milliseconds. The content is delayed for the given delay, then scrolls at a rate of one line per time interval until the end. If the repeat tag is present, it then delays for the repeat time, fades out over 1 second, and repeats. It does not wrap or reset to the top at the end of the scroll. You can use any bool condition to specify when autoscrolling should be allowed. |
See also
Development: