xbmc/guilib/GUIButtonControl.dox

   1 /*!
   2
   3 \page skin_Button_control Button control
   4 \brief **A standard push button control.**
   5
   6 \tableofcontents
   7
   8 The button control is used for creating push buttons in Kodi. You can
   9 choose the position, size, and look of the button, as well as choosing what
  10 action(s) should be performed when pushed.
  11
  12 --------------------------------------------------------------------------------
  13 \section skin_Button_control_sect1 Example
  14
  15 ~~~~~~~~~~~~~
  16 <control type="button" id="1">
  17       <description>My first button 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       <texturefocus colordiffuse="FFFFAAFF">myfocustexture.png</texturefocus>
  25       <texturenofocus colordiffuse="FFFFAAFF">mynormaltexture.png</texturenofocus>
  26       <label>29</label>
  27       <wrapmultiline>true</wrapmultiline>
  28       <font>font12</font>
  29       <textcolor>FFFFFFFF</textcolor>
  30       <focusedcolor>FFFFFFFF</focusedcolor>
  31       <disabledcolor>80FFFFFF</disabledcolor>
  32       <invalidcolor>FFFFFFFF</invalidcolor>
  33       <align></align>
  34       <aligny></aligny>
  35       <textoffsetx></textoffsetx>
  36       <textoffsety></textoffsety>
  37       <pulseonselect></pulseonselect>
  38       <onclick>ActivateWindow(MyVideos)</onclick>
  39       <onfocus>-</onfocus>
  40       <onunfocus>-</onunfocus>
  41       <onup>2</onup>
  42       <ondown>3</ondown>
  43       <onleft>1</onleft>
  44       <onright>1</onright>
  45 </control>
  46 ~~~~~~~~~~~~~
  47
  48 --------------------------------------------------------------------------------
  49 \section skin_Button_control_sect2 Available tags
  50
  51 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  52 the following tags are available. Note that each tag is lower case only. This is
  53 important, as xml tags are case-sensitive.
  54
  55 | Tag           | Description                                                   |
  56 |--------------:|:--------------------------------------------------------------|
  57 | texturefocus  | Specifies the image file which should be displayed when the button has focus. [See here for additional information about textures](http://kodi.wiki/view/Texture_Attributes).
  58 | texturenofocus| Specifies the image file which should be displayed when the button does not have focus.
  59 | label         | The label used on the button. It can be a link into <b>`strings.po`</b>, or an actual text label.
  60 | font          | Font used for the button label. From fonts.xml.
  61 | textcolor     | Color used for displaying the button label. In **AARRGGBB** hex format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  62 | focusedcolor  | Color used for the button label when the button has in focus. In **AARRGGBB** hex format or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  63 | disabledcolor | Color used for the button label if the button is disabled. In **AARRGGBB** hex format or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  64 | invalidcolor  | Color used for the button if the user entered some invalid value. In **AARRGGBB** hex format or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  65 | 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).
  66 | angle         | The angle the text should be rendered at, in degrees. A value of 0 is horizontal.
  67 | align         | Label horizontal alignment on the button. Defaults to left, can also be center or right.
  68 | aligny        | Label vertical alignment on the button. Defaults to top, can also be center.
  69 | textoffsetx   | Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
  70 | textoffsety   | Amount to offset the label from the top edge of the button when using top alignment.
  71 | textwidth     | Will truncate any text that's too long.
  72 | onclick       | Specifies the action to perform when the button is pressed. Should be a built in function. [See here for more information](http://kodi.wiki/view/Built-in_functions_available_to_FTP,_Webserver,_skins,_keymap_and_to_python). You may have more than one <b>`<onclick>`</b> tag, and they'll be executed in sequence.
  73 | onfocus       | Specifies the action to perform when the button is focused. Should be a built in function. The action is performed after any focus animations have completed. [See here for more information](http://kodi.wiki/view/Built-in_functions_available_to_FTP,_Webserver,_skins,_keymap_and_to_python).
  74 | onunfocus     | Specifies the action to perform when the button loses focus. Should be a built in function.
  75 | wrapmultiline | Will wrap the label across multiple lines if the label exceeds the control width.
  76
  77
  78 --------------------------------------------------------------------------------
  79 \section skin_Button_control_sect3 See also
  80 #### Development:
  81
  82 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  83 - [Skinning](http://kodi.wiki/view/Skinning)
  84
  85 */