Settings Spin Control: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Theuni
m (Added reverse action.)
 
(16 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<section begin="main content" />
The settings spin control is used in the settings screens for when a list of options can be chosen from using up/down arrows. You can choose the position, size, and look of the spin control. It is basically a cross between the button control and a spin control. It has a label and focus and non focus textures, as well as a spin control on the right.
The settings spin control is used in the settings screens for when a list of options can be chosen from using up/down arrows. You can choose the position, size, and look of the spin control. It is basically a cross between the button control and a spin control. It has a label and focus and non focus textures, as well as a spin control on the right.
===Example===
=== Example ===
<source lang="xml">
<syntaxhighlight lang="xml" enclose="div">
<control type="spincontrolex" id="12">
<control type="spincontrolex" id="12">
       <description>My first settings spin control</description>
       <description>My first settings spin control</description>
       <posx>80</posx>
       <left>80</left>
       <posy>60</posy>
       <top>60</top>
       <width>250</width>
       <width>250</width>
       <height>200</height>
       <height>200</height>
      <spinposx>220</spinposx>
      <spinposy>180</spinposy>
      <spinwidth>16</spinwidth>
      <spinheight>16</spinheight>
       <visible>true</visible>
       <visible>true</visible>
       <colordiffuse>FFFFFFFF</colordiffuse>
       <colordiffuse>FFFFFFFF</colordiffuse>
Line 16: Line 21:
       <texturedown>mydowntexture.png</texturedown>
       <texturedown>mydowntexture.png</texturedown>
       <texturedownfocus>mydownfocustexture.png</texturedownfocus>
       <texturedownfocus>mydownfocustexture.png</texturedownfocus>
      <textureupdisabled colordiffuse="AAFFAAFF">mydowntexture.png</textureupdisabled>
      <texturedowndisabled colordiffuse="AAFFAAFF">mydownfocustexture.png</texturedowndisabled>
       <label>46</label>
       <label>46</label>
       <font>font12</font>
       <font>font12</font>
Line 25: Line 32:
       <textoffsety></textoffsety>
       <textoffsety></textoffsety>
       <pulseonselect></pulseonselect>
       <pulseonselect></pulseonselect>
      <reverse></reverse>
       <onup>2</onup>
       <onup>2</onup>
       <ondown>3</ondown>
       <ondown>3</ondown>
Line 30: Line 38:
       <onright>1</onright>
       <onright>1</onright>
</control>
</control>
</source>
</syntaxhighlight>


===Available Tags===
=== 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.
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.
{| class="dtable"
 
|- class="userrow"
{| class="prettytable"
| class="usercell" | '''texturefocus'''
! Tag !! Description
| class="usercell" |
|-
Specifies the image file which should be displayed for the control when it has focus. [[Texture Attributes|See here for additional information about textures.]]
|  '''spinposx'''
|- class="userrow"
|  The horizontal position of the spin control for multipage lists. This is offset from the top left of the list.
| class="usercell" | '''texturenofocus'''
|-
| class="usercell" | Specifies the image file which should be displayed for the control when it doesn't focus.
|  '''spinposy'''
|- class="userrow"
|  The vertical position of the spin control for multipage lists. This is offset from the top left of the list.
| class="usercell" | '''textureup'''
|-  
| class="usercell" | Specifies the image file which should be displayed for the up arrow when it doesn't have focus. It is displayed to the left of the down arrow.
| '''spinwidth'''
|- class="userrow"
|  The width of one of the spin control buttons. The textures for this spin control will be scaled to fit this width.
| class="usercell" | '''textureupfocus'''
|-
| class="usercell" | Specifies the image file which should be displayed for the up arrow when it has focus.
| '''spinheight'''
|- class="userrow"
| The height of one of the spin control buttons. The textures for this spin control will be scaled to fit this height.
| class="usercell" | '''texturedown'''
|-
| class="usercell" | Specifies the image file which should be displayed for the down arrow when it is not focused. It is displayed to the right of the up arrow so that it's right edge is <textoffsetx> pixels away from the right edge of the control.
|  '''texturefocus'''
|- class="userrow"
| Specifies the image file which should be displayed for the control when it has focus. [[Texture Attributes|See here for additional information about textures.]]
| class="usercell" | '''texturedownfocus'''
|-  
| class="usercell" | Specifies the image file which should be displayed for the down arrow when it has focus.
| '''texturenofocus'''
|- class="userrow"
| Specifies the image file which should be displayed for the control when it doesn't focus.
| class="usercell" | '''label'''
|-  
| class="usercell" | Either a numeric reference into strings.xml (for localization), or a string that will be shown on the left of the control.
| '''textureup'''
|- class="userrow"
| Specifies the image file which should be displayed for the up arrow when it doesn't have focus. It is displayed to the left of the down arrow.
| class="usercell" | '''font'''
|-  
| class="usercell" | Font used for the controls label. From fonts.xml.
| '''textureupfocus'''
|- class="userrow"
| Specifies the image file which should be displayed for the up arrow when it has focus.
| class="usercell" | '''textcolor'''
|-  
| class="usercell" | Color used for displaying the label. In AARRGGBB hex format, or a name from the [[Colour Themes|colour theme.]]
| '''textureupdisabled'''
|- class="userrow"
|  Specifies the image file which should be displayed for the up arrow when the button is disabled.
| class="usercell" | '''disabledcolor'''
|-
| class="usercell" | Color used for the label if the control is disabled. In AARRGGBB hex format, or a name from the [[Colour Themes|colour theme.]]
| '''texturedown'''
|- class="userrow"
| Specifies the image file which should be displayed for the down arrow when it is not focused. It is displayed to the right of the up arrow so that it's right edge is <textoffsetx> pixels away from the right edge of the control.
| class="usercell" | '''shadowcolor'''
|-  
| class="usercell" | Specifies the color of the drop shadow on the text. In AARRGGBB hex format, or a name from the [[Colour Themes|colour theme.]]
| '''texturedownfocus'''
|- class="userrow"
| Specifies the image file which should be displayed for the down arrow when it has focus.
| class="usercell" | '''align'''
|-  
| class="usercell" | Label horizontal alignment on the control. Defaults to left.
| '''texturedowndisabled'''
|- class="userrow"
|  Specifies the image file which should be displayed for the up arrow when the button is disabled.
| class="usercell" | '''aligny'''
|-
| class="usercell" | Label vertical alignment on the control. Defaults to top, can also be center.
| '''label'''
|- class="userrow"
| Either a numeric reference into strings.po (for localization), or a string that will be shown on the left of the control.
| class="usercell" | '''textoffsetx'''
|-  
| class="usercell" | Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
| '''font'''
|- class="userrow"
| Font used for the controls label. From fonts.xml.
| class="usercell" | '''textoffsety'''
|-  
| class="usercell" | Amount to offset the label from the top edge of the button when using top alignment.
| '''textcolor'''
| Color used for displaying the label. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-  
| '''disabledcolor'''
| Color used for the label if the control is disabled. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-  
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-  
| '''align'''
| Label horizontal alignment on the control. Defaults to 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.
|- 
| '''textwidth'''
| Will truncate any text that's too long.
|- 
| '''reverse'''
| Will reverse the up/down actions of the up and down textures.
|}
|}
[[category:Skin Development]]
 
<section end="main content" />
 
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]
 
[[Category:Skin development]]

Latest revision as of 11:28, 6 March 2024

The settings spin control is used in the settings screens for when a list of options can be chosen from using up/down arrows. You can choose the position, size, and look of the spin control. It is basically a cross between the button control and a spin control. It has a label and focus and non focus textures, as well as a spin control on the right.

Example

<control type="spincontrolex" id="12">
      <description>My first settings spin control</description>
      <left>80</left>
      <top>60</top>
      <width>250</width>
      <height>200</height>
      <spinposx>220</spinposx>
      <spinposy>180</spinposy>
      <spinwidth>16</spinwidth>
      <spinheight>16</spinheight>
      <visible>true</visible>
      <colordiffuse>FFFFFFFF</colordiffuse>
      <texturefocus>myfocustexture.png</texturefocus>
      <texturenofocus>mynofocustexture.png</texturenofocus>
      <textureup>myuptexture.png</textureup>
      <textureupfocus>myupfocustexture.png</textureupfocus>
      <texturedown>mydowntexture.png</texturedown>
      <texturedownfocus>mydownfocustexture.png</texturedownfocus>
      <textureupdisabled colordiffuse="AAFFAAFF">mydowntexture.png</textureupdisabled>
      <texturedowndisabled colordiffuse="AAFFAAFF">mydownfocustexture.png</texturedowndisabled>
      <label>46</label>
      <font>font12</font>
      <textcolor>FFFFFFFF</textcolor>
      <disabledcolor>80FFFFFF</disabledcolor>
      <align></align>
      <aligny></aligny>
      <textoffsetx></textoffsetx>
      <textoffsety></textoffsety>
      <pulseonselect></pulseonselect>
      <reverse></reverse>
      <onup>2</onup>
      <ondown>3</ondown>
      <onleft>1</onleft>
      <onright>1</onright>
</control>

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.

Tag Description
spinposx The horizontal position of the spin control for multipage lists. This is offset from the top left of the list.
spinposy The vertical position of the spin control for multipage lists. This is offset from the top left of the list.
spinwidth The width of one of the spin control buttons. The textures for this spin control will be scaled to fit this width.
spinheight The height of one of the spin control buttons. The textures for this spin control will be scaled to fit this height.
texturefocus Specifies the image file which should be displayed for the control when it has focus. See here for additional information about textures.
texturenofocus Specifies the image file which should be displayed for the control when it doesn't focus.
textureup Specifies the image file which should be displayed for the up arrow when it doesn't have focus. It is displayed to the left of the down arrow.
textureupfocus Specifies the image file which should be displayed for the up arrow when it has focus.
textureupdisabled Specifies the image file which should be displayed for the up arrow when the button is disabled.
texturedown Specifies the image file which should be displayed for the down arrow when it is not focused. It is displayed to the right of the up arrow so that it's right edge is <textoffsetx> pixels away from the right edge of the control.
texturedownfocus Specifies the image file which should be displayed for the down arrow when it has focus.
texturedowndisabled Specifies the image file which should be displayed for the up arrow when the button is disabled.
label Either a numeric reference into strings.po (for localization), or a string that will be shown on the left of the control.
font Font used for the controls label. From fonts.xml.
textcolor Color used for displaying the label. In AARRGGBB hex format, or a name from the colour theme.
disabledcolor Color used for the label if the control is disabled. In AARRGGBB hex format, or a name from the colour theme.
shadowcolor Specifies the color of the drop shadow on the text. In AARRGGBB hex format, or a name from the colour theme.
align Label horizontal alignment on the control. Defaults to 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.
textwidth Will truncate any text that's too long.
reverse Will reverse the up/down actions of the up and down textures.


See also

Development:

Retrieved from "https://kodi.wiki/index.php?title=Settings_Spin_Control&oldid=250235"