Commit 8c245399 authored by Cyril Deguet's avatar Cyril Deguet

* doc about SliderBackground (forgot to commit that a long time ago...)

parent 6e3e276a
......@@ -607,7 +607,7 @@ difficulty to understand how VLC skins work.</para>
<sect2 id="Slider">
<title>Slider</title>
<para>Create a slider.</para>
<para>Create a slider. This element can be used alone, or can contain a <link linkend="SliderBackground">SliderBackground</link> element.</para>
<para>See the <link linkend="commattr">common attributes</link>.</para>
<sect3 id="sliderup">
<title>up</title>
......@@ -646,6 +646,38 @@ difficulty to understand how VLC skins work.</para>
</sect3>
</sect2>
<sect2 id="SliderBackground">
<title>SliderBackground</title>
<para>Set of background images associated to a slider (it must be a sub-element of a <link linkend="Slider">Slider</link>). The displayed image depends on the value of the corresponding slider; if the SliderBackground contains n images, the image #m will be displayed, where m = n * (slider value). A SliderBackground actually contains a single image, which is divided into a grid to build all the sub-images. All the sub-images of the grid have the same size, and can be separated by unused pixel lines or rows if needed (this is called "padding").</para>
<para>See the <link linkend="commattr">common attributes</link>.</para>
<sect3 id="sbg_image">
<title>image</title>
<para>Identifiant of a <link linkend="Bitmap">Bitmap</link>; image containing the sub-images used to draw the background of the slider.</para>
<para><emphasis>Required.</emphasis></para>
</sect3>
<sect3 id="nbhoriz">
<title>nbhoriz</title>
<para>Number of sub-images in the horizontal direction.</para>
<para>Default value: 1</para>
</sect3>
<sect3 id="nbvert">
<title>nbvert</title>
<para>Number of sub-images in the vertical direction.</para>
<para>Default value: 1</para>
</sect3>
<sect3 id="padhoriz">
<title>padhoriz</title>
<para>Horizontal padding: number of unused pixel rows between two sub-images.</para>
<para>Default value: 0</para>
</sect3>
<sect3 id="padvert">
<title>padvert</title>
<para>Vertical padding: number of unused pixel lines between two sub-images.</para>
<para>Default value: 0</para>
</sect3>
</sect2>
<sect2 id="RadialSlider">
<title>RadialSlider</title>
<para>Create a circular slider from a list of images with the different possible positions.</para>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment