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       <textureslidernib>mydowntexture.png</textureslidernib>
  26       <textureslidernibfocus>mydownfocustexture.png</textureslidernibfocus>
  27       <info></info>
  28       <action></action>
  29       <controloffsetx></controloffsetx>
  30       <controloffsety></controloffsety>
  31       <pulseonselect></pulseonselect>
  32       <orientation>vertical</orientation>
  33       <onup>2</onup>
  34       <ondown>3</ondown>
  35       <onleft>1</onleft>
  36       <onright>1</onright>
  37 </control>
  38 ~~~~~~~~~~~~~
  39
  40
  41 --------------------------------------------------------------------------------
  42 \section Slider_Control_sect2 Available tags
  43
  44 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  45 the following tags are available. Note that each tag is lower case only. This is
  46 important, as xml tags are case-sensitive.
  47
  48 | Tag                   | Description                                                   |
  49 |----------------------:|:--------------------------------------------------------------|
  50 | 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).
  51 | textureslidernib      | Specifies the image file which should be displayed for the slider nib.
  52 | textureslidernibfocus | Specifies the image file which should be displayed for the slider nib when it has focus.
  53 | 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).
  54 | controloffsety        | Amount to offset the slider background texture from the top edge of the control.
  55 | info                  | Specifies the information that the slider controls. [See here for more information](http://kodi.wiki/view/InfoLabels).
  56 | orientation           | Specifies whether this scrollbar is horizontal or vertical. Defaults to vertical.
  57 | 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.
  58
  59 \section Slider_Control_revhistory Revision History
  60
  61 @skinning_v18 <b>[Slider Control]</b> Added <b>`pvr.seek`</b> as possible <b>action</b> tag value (timeshifting in PVR).
  62
  63 --------------------------------------------------------------------------------
  64 \section Slider_Control_sect3 See also
  65
  66 #### Development:
  67
  68 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  69 - [Skinning](http://kodi.wiki/view/Skinning)
  70
  71 */