xbmc/guilib/GUISliderControl.dox

   1 /*!
   2
   3 \page Slider_Control Slider Control
   4 \brief **Used for a volume slider.**
   5
   6 \tableofcontents
   7
   8 The slider control is used for things where a sliding bar best represents the
   9 operation at hand (such as a volume control or seek control). You can choose
  10 the position, size, and look of the slider control.
  11
  12
  13 --------------------------------------------------------------------------------
  14 \section Slider_Control_sect1 Example
  15
  16 ~~~~~~~~~~~~~
  17 <control type="slider" id="17">
  18       <description>My first slider control</description>
  19       <posx>80</posx>
  20       <posy>60</posy>
  21       <width>250</width>
  22       <height>30</height>
  23       <visible>true</visible>
  24       <texturesliderbar>mybackgroundtexture.png</texturesliderbar>
  25       <texturesliderbardisabled>mydisabledbackgroundtexture.png</texturesliderbardisabled>
  26       <textureslidernib>mydowntexture.png</textureslidernib>
  27       <textureslidernibfocus>mydownfocustexture.png</textureslidernibfocus>
  28       <textureslidernibdisabled>mydisablednibtexture.png</textureslidernibdisabled>
  29       <info></info>
  30       <action></action>
  31       <controloffsetx></controloffsetx>
  32       <controloffsety></controloffsety>
  33       <pulseonselect></pulseonselect>
  34       <orientation>vertical</orientation>
  35       <onup>2</onup>
  36       <ondown>3</ondown>
  37       <onleft>1</onleft>
  38       <onright>1</onright>
  39 </control>
  40 ~~~~~~~~~~~~~
  41
  42
  43 --------------------------------------------------------------------------------
  44 \section Slider_Control_sect2 Available tags
  45
  46 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  47 the following tags are available. Note that each tag is lower case only. This is
  48 important, as xml tags are case-sensitive.
  49
  50 | Tag                      | Description                                                   |
  51 |-------------------------:|:--------------------------------------------------------------|
  52 | 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).
  53 | texturesliderbardisabled | Specifies the image file which should be displayed in the background of the slider control when it is disabled.
  54 | textureslidernib         | Specifies the image file which should be displayed for the slider nib.
  55 | textureslidernibfocus    | Specifies the image file which should be displayed for the slider nib when it has focus.
  56 | textureslidernibdisabled | Specifies the image file which should be displayed for the slider nib when it is disabled.
  57 | 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).
  58 | controloffsety           | Amount to offset the slider background texture from the top edge of the control.
  59 | info                     | Specifies the information that the slider controls. [See here for more information](http://kodi.wiki/view/InfoLabels).
  60 | orientation              | Specifies whether this scrollbar is horizontal or vertical. Defaults to vertical.
  61 | 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.
  62
  63 \section Slider_Control_revhistory Revision History
  64
  65 @skinning_v18 <b>[Slider Control]</b> Added <b>`pvr.seek`</b> as possible <b>action</b> tag value (timeshifting in PVR).
  66
  67 --------------------------------------------------------------------------------
  68 \section Slider_Control_sect3 See also
  69
  70 #### Development:
  71
  72 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  73 - [Skinning](http://kodi.wiki/view/Skinning)
  74
  75 */