xbmc/guilib/GUIScrollBarControl.dox

   1 /*!
   2
   3 \page Scroll_Bar_Control Scroll Bar Control
   4 \brief **Used for a implementing a scroll bar.**
   5
   6 \tableofcontents
   7
   8 The scroll bar control is used as a page control for lists, panels, wraplists,
   9 fixedlists, textboxes, and grouplists. You can choose the position, size, and
  10 look of the scroll bar.
  11
  12
  13 --------------------------------------------------------------------------------
  14 \section Scroll_Bar_Control_sect Example
  15
  16 ~~~~~~~~~~~~~
  17 <control type="scrollbar" id="17">
  18       <description>My first scroll bar control</description>
  19       <posx>80</posx>
  20       <posy>60</posy>
  21       <width>250</width>
  22       <height>30</height>
  23       <visible>true</visible>
  24       <texturesliderbackground>scroll-background.png</texturesliderbackground>
  25       <texturesliderbar>bar.png</texturesliderbar>
  26       <texturesliderbarfocus>bar-focus.png</texturesliderbarfocus>
  27       <textureslidernib>nib.png</textureslidernib>
  28       <textureslidernibfocus>nib-focus.png</textureslidernibfocus>
  29       <pulseonselect></pulseonselect>
  30       <orientation>vertical</orientation>
  31       <showonepage>false</showonepage>
  32       <onup>2</onup>
  33       <ondown>3</ondown>
  34       <onleft>1</onleft>
  35       <onright>1</onright>
  36 </control>
  37 ~~~~~~~~~~~~~
  38
  39
  40 --------------------------------------------------------------------------------
  41 \section Scroll_Bar_Control_sect2 Available tags
  42
  43 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  44 the following tags are available. Note that each tag is lower case only. This is
  45 important, as xml tags are case-sensitive.
  46
  47 | Tag                     | Description                                                   |
  48 |------------------------:|:--------------------------------------------------------------|
  49 | texturesliderbackground | Specifies the image file which should be displayed in the background of the scroll bar control. [See here for additional information about textures](http://kodi.wiki/view/Texture_Attributes).
  50 | texturesliderbar        | Specifies the image file which should be displayed for the scroll bar. As the size of the scroll bar is dynamic, it is often useful to [use the border attribute of this texture](http://kodi.wiki/view/Texture_Attributes).
  51 | texturesliderbarfocus   | Specifies the image file which should be displayed for the scroll bar when it has focus.
  52 | textureslidernib        | Specifies the image file which should be displayed for the scroll bar nib. The nib is always centered within the scroll bar.
  53 | textureslidernibfocus   | Specifies the image file which should be displayed for the scroll bar nib when it has focus. The nib is always centered within the scroll bar.
  54 | orientation             | Specifies whether this scrollbar is horizontal or vertical. Defaults to vertical.
  55 | showonepage             | Specifies whether the scrollbar will show if the container it's controlling has just one page. Defaults to true.
  56
  57 \section Scroll_Bar_Control_sect3 Adding Up and Down buttons above and below a scrollbar
  58 To add arrow buttons above and below the scrollbar, you need to add 2 additional button controls to the window, and set their <b>`<onclick>`</b> tag to
  59
  60 ~~~~~~~~~~~~~
  61 <onclick>pageup(id)</onclick>
  62 ~~~~~~~~~~~~~
  63 or
  64 ~~~~~~~~~~~~~
  65 <onclick>pagedown(id)</onclick>
  66 ~~~~~~~~~~~~~
  67
  68 where id is the id of this scroll bar.
  69
  70
  71 --------------------------------------------------------------------------------
  72 \section Scroll_Bar_Control_sect4 See also
  73
  74 #### Development:
  75
  76 - [Add-on development](http://kodi.wiki/view/Add-on_development)
  77 - [Skinning](http://kodi.wiki/view/Skinning)
  78
  79 */