summaryrefslogtreecommitdiffstats
path: root/xbmc/guilib/GUISliderControl.dox
blob: 10bd2ba5145b6e0deeecfd0b9d12a8b48c717c08 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*!

\page Slider_Control Slider Control
\brief **Used for a volume slider.**

\tableofcontents

The slider control is used for things where a sliding bar best represents the
operation at hand (such as a volume control or seek control). You can choose
the position, size, and look of the slider control.


--------------------------------------------------------------------------------
\section Slider_Control_sect1 Example

~~~~~~~~~~~~~
<control type="slider" id="17">
      <description>My first slider control</description>
      <posx>80</posx>
      <posy>60</posy>
      <width>250</width>
      <height>30</height>
      <visible>true</visible>
      <texturesliderbar>mybackgroundtexture.png</texturesliderbar>
      <textureslidernib>mydowntexture.png</textureslidernib>
      <textureslidernibfocus>mydownfocustexture.png</textureslidernibfocus>
      <info></info>
      <action></action>
      <controloffsetx></controloffsetx>
      <controloffsety></controloffsety>
      <pulseonselect></pulseonselect>
      <orientation>vertical</orientation>
      <onup>2</onup>
      <ondown>3</ondown>
      <onleft>1</onleft>
      <onright>1</onright>
</control>
~~~~~~~~~~~~~


--------------------------------------------------------------------------------
\section Slider_Control_sect2 Available tags

In addition to the [Default Control Tags](http://kodi.wiki/view/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                                                   |
|----------------------:|:--------------------------------------------------------------|
| texturesliderbar      | Specifies the image file which should be displayed in the background of the slider control. [See here for additional information about textures](http://kodi.wiki/view/Texture_Attributes).
| textureslidernib      | Specifies the image file which should be displayed for the slider nib.
| textureslidernibfocus | Specifies the image file which should be displayed for the slider nib when it has focus.
| controloffsetx        | Amount to offset the slider background texture from the left edge of the control. Only useful if a value is being rendered as well (ie in int or float mode).
| controloffsety        | Amount to offset the slider background texture from the top edge of the control.
| info                  | Specifies the information that the slider controls. [See here for more information](http://kodi.wiki/view/InfoLabels).
| orientation           | Specifies whether this scrollbar is horizontal or vertical. Defaults to vertical.
| action                | Can be <b>`volume`</b> to adjust the volume, <b>`seek`</b> to change the seek position, <b>`pvr.seek`</b> for timeshifting in PVR.

\section Slider_Control_revhistory Revision History

@skinning_v18 <b>[Slider Control]</b> Added <b>`pvr.seek`</b> as possible <b>action</b> tag value (timeshifting in PVR).

--------------------------------------------------------------------------------
\section Slider_Control_sect3 See also

#### Development:

- [Add-on development](http://kodi.wiki/view/Add-on_development)
- [Skinning](http://kodi.wiki/view/Skinning)

*/