xbmc/guilib/GUIRangesControl.dox

   1 /*!
   2
   3 \page Ranges_Control Ranges Control
   4 \brief **Used to show multiple range blocks**
   5
   6 \tableofcontents
   7
   8 The ranges control is used for showing multiple range UI elements on the same control. It is used
   9 in Kodi, for example, to show the intervals of a cutlist (EDL) or chapters in the video seekbar.
  10 You can choose the position, size and look and feel of the control.
  11
  12 --------------------------------------------------------------------------------
  13 \section Ranges_Control_sect1 Example
  14
  15 ~~~~~~~~~~~~~xml
  16 <control type="ranges">
  17     <left>0</left>
  18     <top>70</top>
  19     <width>100%</width>
  20     <height>8</height>
  21     <texturebg border="3" colordiffuse="00FFFFFF">colors/white50.png</texturebg>
  22     <lefttexture>colors/white.png</lefttexture>
  23     <midtexture colordiffuse="FFFF0000">colors/white.png</midtexture>
  24     <righttexture>colors/white.png</righttexture>
  25     <info>Player.Editlist</info>
  26 </control>
  27 ~~~~~~~~~~~~~
  28
  29 --------------------------------------------------------------------------------
  30 \section Ranges_Control_sect2 Available tags
  31
  32 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  33 the following tags are available. Note that each tag is lower case only. This is
  34 important, as xml tags are case-sensitive.
  35
  36 | Tag           | Description                                                   |
  37 |--------------:|:--------------------------------------------------------------|
  38 | texturebg     | The background texture for the range control.
  39 | lefttexture   | The texture used in the left hand side of the range
  40 | midtexture    | The texture used for the mid section of the range
  41 | righttexture  | The texture used in the right hand side of the range
  42 | info          | Specifies the information the range control holds. It expects an infolabel that returns a string in CSV format: e.g. `"start1,end1,start2,end2,..."`. Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token. Examples of currently supported infolabels are \link Player_Editlist `Player.Editlist`\endlink, \link Player_Cutlist `Player.Cutlist`\endlink, \link Player_Cuts `Player.Cuts`\endlink, \link Player_SceneMarkers `Player.Cutlist`\endlink and \link Player_Chapters `Player.Chapters`\endlink. \n @deprecated \link Player_Cutlist `Player.Cutlist`\endlink is deprecated use \link Player_Cuts `Player.Cuts`\endlink instead.
  43
  44 \section Ranges_Control_sect3 Revision History
  45
  46 @skinning_v19 <b>[Ranges Control]</b> New control added.
  47
  48 --------------------------------------------------------------------------------
  49 \section Ranges_Control_sect4 See also
  50
  51 #### Development:
  52
  53 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  54 - [Skinning](http://kodi.wiki/view/Skinning)
  55
  56 */