xbmc/guilib/GUITextBox.dox

   1 /*!
   2
   3 \page Text_Box Text Box
   4 \brief **Used to show a multi-page piece of text.**
   5
   6 \tableofcontents
   7
   8 The text box is used for showing a large multipage piece of text in Kodi. You
   9 can choose the position, size, and look of the text.
  10
  11
  12 --------------------------------------------------------------------------------
  13 \section Text_Box_sect1 Example
  14
  15 ~~~~~~~~~~~~~
  16 <control type="textbox" id="2">
  17    <description>My first text box control</description>
  18    <posx>80</posx>
  19    <posy>60</posy>
  20    <width>250</width>
  21    <height>200</height>
  22    <visible>true</visible>
  23    <colordiffuse>FFFFFFFF</colordiffuse>
  24    <font>font13</font>
  25    <textcolor>FFFFFFFF</textcolor>
  26    <pulseonselect></pulseonselect>
  27    <pagecontrol>13</pagecontrol>
  28    <scrolltime>200</scrolltime>
  29    <autoscroll delay="3000" time="1000" repeat="10000">!Control.HasFocus(13)</autoscroll>
  30    <label>Text to display goes here [CR] next line...</label>
  31    <align>center</align>
  32 </control>
  33 ~~~~~~~~~~~~~
  34
  35
  36 --------------------------------------------------------------------------------
  37 \section Text_Box_sect2 Available tags
  38
  39 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  40 the following tags are available. Note that each tag is lower case only. This is
  41 important, as xml tags are case-sensitive.
  42
  43 | Tag           | Description                                                   |
  44 |--------------:|:--------------------------------------------------------------|
  45 | height        | <b>`<height>auto</height>`</b> is supported in textbox controls
  46 | font          | Font used for the items first label. From `fonts.xml`.
  47 | textcolor     | Color used for displaying the text. In **AARRGGBB** hex format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  48 | shadowcolor   | Specifies the color of the drop shadow on the text. In **AARRGGBB** format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  49 | pagecontrol   | Specifies the <b>`<id>`</b> of the page control used to control this textbox. The page control can either be a \ref Spin_Control "Spin Control" or a \ref Scroll_Bar_Control "Scroll Bar Control".
  50 | scrolltime    | The time (in ms) to scroll from one item to another. By default, this is *200ms*. The list will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling.
  51 | align         | possible values for text alignment: left, right, center, justify
  52 | 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](http://kodi.wiki/view/List_of_Boolean_Conditions) to specify when autoscrolling should be allowed.
  53
  54
  55 --------------------------------------------------------------------------------
  56 \section Text_Box_sect3 See also
  57
  58 #### Development:
  59
  60 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  61 - [Skinning](http://kodi.wiki/view/Skinning)
  62
  63 */