Wiki Navigation
- Loading...
Description
This control aggregates the look and behavior of the spin control and the button control. he up/down arrows are able to be independently focused for control. As the button is clicked the focused arrow scrolls the list of available values and displays each new value to the left of the up/down arrows.
Images
Changelog
Change | Date | Version |
|---|---|---|
2010/10/05 | 1.1.0 to 1.2.0 | |
2011/12/17 | 1.2.0 to 1.3.0 | |
2010/10/10 | 1.0.1 to 1.1.0 | |
2013/01/27 | 1.2.0 to 1.3.0 | |
Tags
GUISpinButton (spinbutton)
On Mon, 06 Dec 2010, Dadeo suggested that this table is incomplete and needs to be expanded to describe all Tags or elements.
Element Name | Data Type | Description |
|---|---|---|
textureFocus [border, position, textureRepeat, textureRotate, texture, colorKey, corners, cornerRotate, mask, tileFill] | String | The texture to display when the button has the focus/is selected. |
border | String | With this feature you have the ability to add borders composed from textures that you identify. See Borders for a more detailed description. |
position | BorderPosition | Specifies the position of the border relative to the image or control rectangle edges. Valid values are OutsideImage, InsideImage, CenterImage, OutsideControl, InsideControl, CenterControl. The default value is "OutsideImage". Example: <border position="CenterControl">10</border>. |
textureRepeat | Boolean | |
textureRotate | Boolean | |
texture | String | |
colorKey | Long | |
corners | Boolean | |
cornerRotate | Boolean | |
mask | ||
tileFill | Boolean | Specifies that the border texture should be used as a tile to fill the border rectangles, and not stretched to fill the border rectangles. The texture should be square and have dimensions that are powers of two (for example, 8x8 or 16x16). If the texture is not square, the shorter dimension is stretched to the length of the longer dimension to make a square tile. If the dimensions are not powers of two, gaps will occur between the tiles. |
textureNoFocus [border, position, textureRepeat, textureRotate, texture, colorKey, corners, cornerRotate, mask, tileFill] | String | The texture to display when the button does not have the focus/is not selected. |
border | String | With this feature you have the ability to add borders composed from textures that you identify. See Borders for a more detailled description. |
position | BorderPosition | Specifies the position of the border relative to the image or control rectangle edges. Valid values are OutsideImage, InsideImage, CenterImage, OutsideControl, InsideControl, CenterControl. The default value is "OutsideImage". See Borders for a more detailled description. |
textureRepeat | Boolean | Specifies whether the texture used for the border should repeat or stretch inside each of the four rectangles that compose the overall border. The default value is "no". Example: <border textureRepeat="yes">10</border>. |
textureRotate | Boolean | |
texture | String | |
colorKey | Long | |
corners | Boolean | |
cornerRotate | Boolean | |
mask | ||
tileFill | Boolean | Specifies that the border texture should be used as a tile to fill the border rectangles, and not stretched to fill the border rectangles. The texture should be square and have dimensions that are powers of two (for example, 8x8 or 16x16). If the texture is not square, the shorter dimension is stretched to the length of the longer dimension to make a square tile. If the dimensions are not powers of two, gaps will occur between the tiles. |
font | String | The font to use to display the button text. |
label | String | The button text, property or a number that corresponds to an id in the strings.xml file. |
textcolor | Long | The color of the text when the button has the focus/is selected. |
textcolorNoFocus | Long | The color of the text when the button is not selected. |
disabledcolor | Long | The color of the text when the button is disabled. |
textXOff | Integer | The number of pixels the text label is offset from the left edge of the button image. |
textYOff [hasMargin] | Integer | The number of pixels the text label is offset from the top edge of the button image. |
hasMargin | Boolean | [Since 1.3] If true, textXOff is used to provide horizontal space before and after the button label. |
textpadding | Integer | [Since 1.3] provides "space" inside the label text to prevent overlap with graphics that follow on the right. |
textureUp | String | |
textureDown | String | |
textureUpFocus | String | |
textureDownFocus | String | |
spinWidth | Integer | |
spinHeight | Integer | |
spinXOff | Integer | |
spinYOff | Integer | |
spinalign | Alignment | |
spinvalign | VAlignment | |
spinPrefixText | String | |
spinSuffixText | String | |
spinTextXOff | Integer | |
spinTextYOff | Integer | |
spinTextInButton | Boolean | |
showrange | Boolean | |
digits | Integer | |
reverse | Boolean | |
cycleItems | Boolean | |
spintype | SpinType | |
orientation | eOrientation | |
shadowAngle | Integer | |
shadowDistance | Integer | |
shadowColor | Long | |
textalign | Alignment | |
textvalign | VAlignment | |
scrollStartDelaySec | Integer | |
scrollWrapString | String | |
onclick | String | [Since 1.3] Executes a MediaPortal skin function when the button is clicked. See Skin Settings for more information. |
Inherited by GUIControl
See GUIControl for the full documentation of this control.
Element Name | Data Type | Description |
|---|---|---|
id | Integer | The id of the control. The id will couple the skin file to the code, so if we later on want to check that a user pressed a button, the id will be required and must be unique. For controls that will never be referenced in the code it is safe to set it to "1" |
description | String | An optional description of the control for your reference |
type | String | The type of the control, for instance "button", "label", "textbox" and all other controls. |
posX | Integer | The X-position on the window for this control |
posY | Integer | The Y-position on the window for this control |
width | Integer | The width of this control |
height | Integer | The height of this control |
onleft | Integer | The control id to move the focus to when the user moves left. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported. |
onright | Integer | The control id to move the focus to when the user moves right. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported. |
onup | Integer | The control id to move the focus to when the user moves up. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported. |
ondown | Integer | The control id to move the focus to when the user moves down. If not specified (or zero) MediaPortal will find the closest control in that direction to move to. As of v1.7.0 Skin Settings and Skin Expressions are also supported. |
colordiffuse | Long | Allows you to mix a color & a graphics texture. E.g. If you have a graphics texture like a blue button you can mix it with a yellow color diffuse and the end result will be green. Defaults to 0xFFFFFFFF |
dimColor | Integer | Color for a control when it is not focussed. Defaults to half transparent (0x60ffffff) |
onfocus | String | [Since 1.3] Executes a MediaPortal skin function when the control gains focus. See Skin Settings for more information. |
Properties Exposed
GUISpinButtonControl (spinbutton)
Property Name | Data Type | Description |
|---|---|---|
#highlightedbutton | String | Sets the value to the label text when the button is highlighted |
XML Examples
<control> <description>de-interlacing</description> <type>spinbutton</type> <id>22</id> <label>6003</label> <onleft>11</onleft> <onright>11</onright> <onup>30</onup> <ondown>23</ondown> <textureUp>scroll-up.png</textureUp> <textureUpFocus>scroll-up-focus.png</textureUpFocus> <textureDown>scroll-down.png</textureDown> <textureDownFocus>scroll-down-focus.png</textureDownFocus> <spinWidth>16</spinWidth> <spinHeight>16</spinHeight> <spinXOff>13</spinXOff> <spinTextXOff>7</spinTextXOff> <spinalign>right</spinalign> <spinvalign>middle</spinvalign> <spintype>text</spintype> <showrange>no</showrange> <reverse>yes</reverse> <cycleItems>yes</cycleItems> <height>34</height> <width>995</width> <font>menu</font> <shadowAngle>45</shadowAngle> <shadowDistance>1</shadowDistance> <shadowColor>FF000000</shadowColor> <textcolor>#settings.buttonTextColor</textcolor> <textalign>left</textalign> <textvalign>middle</textvalign> <textXOff>10</textXOff> <textureFocus border="1" position="insideimage" colorKey="66FFFFFF">list-focus.png</textureFocus> <textureNoFocus>list-nofocus.png</textureNoFocus> </control>
Position text using textXOff while preserving the width of the label text by setting the textXOff property hasMargin to "no";
<textXOff hasMargin="no">20</textXOff>
This page has no comments.