Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Scroll Bar Control

Used for a implementing a scroll bar.

The scroll bar control is used as a page control for lists, panels, wraplists, fixedlists, textboxes, and grouplists. You can choose the position, size, and look of the scroll bar.


Example

<control type="scrollbar" id="17">
<description>My first scroll bar control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>30</height>
<visible>true</visible>
<texturesliderbackground>scroll-background.png</texturesliderbackground>
<texturesliderbar>bar.png</texturesliderbar>
<texturesliderbarfocus>bar-focus.png</texturesliderbarfocus>
<textureslidernib>nib.png</textureslidernib>
<textureslidernibfocus>nib-focus.png</textureslidernibfocus>
<pulseonselect></pulseonselect>
<orientation>vertical</orientation>
<showonepage>false</showonepage>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
</control>
const char const uint8_t size_t unsigned int unsigned int * height
Definition kodi-dev-kit/include/kodi/c-api/addon-instance/ImageDecoder.h:417
const char const uint8_t size_t unsigned int * width
Definition kodi-dev-kit/include/kodi/c-api/addon-instance/ImageDecoder.h:416

Available tags

In addition to the 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
texturesliderbackground Specifies the image file which should be displayed in the background of the scroll bar control. See here for additional information about textures.
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.
texturesliderbarfocus Specifies the image file which should be displayed for the scroll bar when it has focus.
textureslidernib Specifies the image file which should be displayed for the scroll bar nib. The nib is always centered within the scroll bar.
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.
orientation Specifies whether this scrollbar is horizontal or vertical. Defaults to vertical.
showonepage Specifies whether the scrollbar will show if the container it's controlling has just one page. Defaults to true.

Adding Up and Down buttons above and below a scrollbar

To add arrow buttons above and below the scrollbar, you need to add 2 additional button controls to the window, and set their <onclick> tag to

<onclick>pageup(id)</onclick>

or

<onclick>pagedown(id)</onclick>

where id is the id of this scroll bar.


See also

Development: