Button control

From Official Kodi Wiki
Revision as of 03:23, 24 July 2007 by >Jmarshall
Jump to navigation Jump to search

The button control is used for creating push buttons in XBMC. You can choose the position, size, and look of the button, as well as choosing what action(s) should be performed when pushed.

Example

<xml> <control type="button" id="1">

     <description>My first button control</description>
     <posx>80</posx>
     <posy>60</posy>
     <width>250</width>
     <height>200</height>
     <visible>true</visible>
     <colordiffuse>FFFFFFFF</colordiffuse>
     <texturefocus>myfocustexture.png</texturefocus>
     <texturenofocus>mynormaltexture.png</texturenofocus>
     <label>29</label>
     font12
     <textcolor>FFFFFFFF</textcolor>
     <disabledcolor>80FFFFFF</disabledcolor>
     <align></align>
     <aligny></aligny>
     <textoffsetx></textoffsetx>
     <textoffsety></textoffsety>
     <pulseonselect></pulseonselect>
     <onclick>XBMC.ActivateWindow(MyVideos)</onclick>
     <onfocus>-</onfocus>
     <onup>2</onup>
     <ondown>3</ondown>
     <onleft>1</onleft>
     <onright>1</onright>

</control> </xml>

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.

texturefocus

Specifies the image file which should be displayed when the button has focus. You can use animated gif's, jpgs, pngs, or bmps. This should be the path to the image file from the media/ folder of your skin directory. XBMC will first look inside the compresses Textures.xpr file, and if not found, will look inside the media/ folder for the actual skin file. Compressing textures into Textures.xpr means far faster loading times. See here for texture tag attributes.

texturenofocus Specifies the image file which should be displayed when the button does not have focus.
label The label used on the button. It can be a link into strings.xml, or an actual text label.
font Font used for the button label. From fonts.xml.
textcolor Color used for displaying the button label. In AARRGGBB hex format, or a name from the colour theme.
disabledcolor Color used for the button label if the button is disabled, 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.
angle The angle the text should be rendered at, in degrees. A value of 0 is horizontal.
align Label horizontal alignment on the button. Defaults to left, can also be center or right.
aligny Label vertical alignment on the button. Defaults to top, can also be center.
textoffsetx Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
textoffsety Amount to offset the label from the top edge of the button when using top alignment.
onclick

Specifies the action to perform when the button is pressed. Should be a built in function. See here for more information. You may have more than one <onclick> tag, and they'll be executed in sequence.

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.