Spin Control: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Dankula
 
>DonJ
No edit summary
Line 130: Line 130:
| class="usercell" | Control id to move to when the user moves right off this control.
| class="usercell" | Control id to move to when the user moves right off this control.
|}
|}
[[category:Skin Development]]

Revision as of 23:33, 24 January 2007

The spin control is used for when a list of options can be chosen (such as a page up/down control). You can choose the position, size, and look of the spin control.

Example

<xml> <control>

     <description>My first spin control</description>
     <type>spincontrol</type>
     <id>1</id>
     <posx>80</posx>
     <posy>60</posy>
     <width>250</width>
     <height>200</height>
     <visible>true</visible>
     <colordiffuse>FFFFFFFF</colordiffuse>
     <textureup>myuptexture.png</textureup>
     <textureupfocus>myupfocustexture.png</textureupfocus>
     <texturedown>mydowntexture.png</texturedown>
     <texturedownfocus>mydownfocustexture.png</texturedownfocus>
     <subtype>int</subtype>
     <range>0,50,5</range>
     <reverse>true</reverse>
     font12
     <textcolor>FFFFFFFF</textcolor>
     <disabledcolor>80FFFFFF</disabledcolor>
     <align></align>
     <aligny></aligny>
     <textoffsetx></textoffsetx>
     <textoffsety></textoffsety>
     <pulseonselect></pulseonselect>
     <onup>2</onup>
     <ondown>3</ondown>
     <onleft>1</onleft>
     <onright>1</onright>

</control> </xml>

Available Tags

Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

description Only used to make things clear for the skinner. Not read by XBMC at all.
type Should be spincontrol for a spin control.
id Specifies the control's id. The value this takes depends on the control type, and the window that you are using the control on. There are special control id's that must be present in each window. As the contents of the control is filled and controlled by XBMC, a spincontrol's id is unique.
posx Specifies where the left edge of the down button of the spin control should be drawn. If <align> is set to “left”, then this specifies where the label is drawn, and the down button is positioned 5 pixels after the label finishes. This is offset from the window's coordinates (normally the left edge of the screen, or 0).
posy Specifies where the top edge of the down button of the spin control should be drawn. This is offset from the window's coordinates (normally the top edge of the screen, or 0).
width Specifies the width of the up and down buttons. The texture images for the up and down buttons will be resized to fit into this width.
height Specifies the height of the up and down buttons. The texture images for the up and down buttons will be resized to fit into this height.
visible

Specifies a condition as to when this control will be visible. Can be true, false, or a condition. See here for more information. Defaults to true.

animation

Specifies the animation to be run when the control enters a particular state. See here for more information.

textureup

Specifies the image file which should be displayed for the up arrow when it doesn't have 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.

textureupfocus Specifies the image file which should be displayed for the up button when it has focus.
texturedown Specifies the image file which should be displayed for the down button when it is not focused.
texturedownfocus Specifies the image file which should be displayed for the down button when it has focus.
colordiffuse This specifies the color to be used for the texture basis. It's in hex AARRGGBB format. If you define <colordiffuse>FFFF00FF</colordiffuse> (magenta), the image will be given a magenta tint when rendered. Defaults to FFFFFFFF (no tint).
font Font used for the button label. From fonts.xml.
textcolor Color used for displaying the label. In AARRGGBB hex format.
disabledcolor Color used for the label if the control is disabled.
shadowcolor Specifies the color of the drop shadow on the text, in AARRGGBB format.
subtype Defines what type of information the spinner holds. Can be int, float or text. Defaults to text.
reverse Whether the spin buttons should work forwards or backwards. If true, the “up” button will increment the value. If false, the “down” button increments the value. Defaults to false.
range Only valid if <subtype> is int or float. Format is min,max,interval. eg <range>0,50,5</range> will fill the spin control with 0, 5, 10, ..., 45, 50 as values.
align Label horizontal alignment on the control. Defaults to right, can also be left.
aligny Label vertical alignment on the control. 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.
pulseonselect Specifies whether the button should pulse when it's selected. Defaults to true.
onup Control id to move to when the user moves up off this control.
ondown Control id to move to when the user moves down off this control.
onleft Control id to move to when the user moves left off this control.
onright Control id to move to when the user moves right off this control.