xbmc/guilib/GUIEditControl.dox

   1 /*!
   2
   3 \page skin_Edit_control Edit control
   4 \brief **Used as an input control for the osd keyboard and other input fields.**
   5
   6 \tableofcontents
   7
   8 The edit control allows a user to input text in Kodi. You can choose the font,
   9 size, colour, location and header of the text to be displayed.
  10
  11 --------------------------------------------------------------------------------
  12 \section skin_Edit_control_sect1 Example
  13
  14 ~~~~~~~~~~~~~
  15   <control type="edit" id="1">
  16         <description>My First edit control</description>
  17         <posx>80</posx>
  18         <posy>60</posy>
  19         <width>250</width>
  20         <visible>true</visible>
  21         <aligny>center</aligny>
  22         <label>Search</label>
  23         <hinttext>Enter search string</hinttext>
  24         <font>font14</font>
  25         <textoffsetx>10</textoffsetx>
  26         <textcolor>FFB2D4F5</textcolor>
  27         <disabledcolor>FF000000</disabledcolor>
  28         <invalidcolor>FFFFFFFF</invalidcolor>
  29         <texturefocus>button-focus.png</texturefocus>
  30         <texturenofocus>button-nofocus.png</texturenofocus>
  31         <pulseonselect>no</pulseonselect>
  32   </control>
  33 ~~~~~~~~~~~~~
  34
  35 --------------------------------------------------------------------------------
  36 \section skin_Edit_control_sect2 Available tags
  37
  38 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  39 the following tags are available. Note that each tag is **lower case** only. This is
  40 important, as `xml` tags are case-sensitive.
  41
  42 | Tag           | Description                                                   |
  43 |--------------:|:--------------------------------------------------------------|
  44 | aligny        | Can be top or center. Aligns the text within its given control <b>`<height>`</b>. Defaults to top
  45 | label         | Specifies the header text which should be shown. You should specify an entry from the **strings.po** here (either the Kodi strings.po or your skin's strings.po file), however you may also hardcode a piece of text also if you wish, though of course it will not be localized. You can use the full [label formatting syntax](http://kodi.wiki/view/Label_Formatting) and [you may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.strings.po](http://kodi.wiki/view/Label_Parsing))
  46 | hinttext      | Specifies the text which should be displayed in the edit label control, until the user enters some text. It can be used to provide a clue as to what a user should enter in this control.
  47 | font          | Specifies the font to use from the **font.xml** file.
  48 | textcolor     | Specifies the color the text should be, in hex **AARRGGBB** format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  49 | textwidth     | Will truncate any text that's too long.
  50
  51
  52 --------------------------------------------------------------------------------
  53 \section skin_Edit_control_sect3 See also
  54
  55 #### Development:
  56
  57 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  58 - [Skinning](http://kodi.wiki/view/Skinning)
  59
  60 */