4e0f0299d3552a2da74f2a767477845777cc7d2d
[vlc.git] / doc / skins / skins2-howto.xml
1 <?xml version="1.0" encoding="iso8859-1" ?>
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN" "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd">
3
4 <!-- vim: set ts=2 sts=2 sw=2 et -->
5
6 <article id="skin-creation-howto">
7
8 <articleinfo>
9
10 <title>HowTo create your own skin</title>
11
12 <copyright>
13 <year>2004-2006</year>
14 <holder>
15 the VideoLAN project
16 </holder>
17 </copyright>
18
19 <abstract>
20 <para>
21 Skin creation HowTo
22 </para>
23 </abstract>
24
25 <legalnotice>
26 <para>
27 Permission is granted to copy, distribute and/or
28 modify this document under the terms of the GNU General Public License
29 as published by the Free Software Foundation; either version 2 of the
30 License, or (at your option) any later version. The text of the license
31 can be found on <ulink url="http://www.gnu.org/copyleft/gpl.html">the GNU
32 website</ulink>.
33 </para>
34 </legalnotice>
35
36 <authorgroup>
37   <author>
38   <firstname>Olivier</firstname>
39   <surname>Teulière</surname>
40   </author>
41 </authorgroup>
42
43 <keywordset>
44     <keyword>VLC</keyword>
45     <keyword>Skin</keyword>
46     <keyword>XML</keyword>
47     <keyword>Bezier</keyword>
48 </keywordset>
49
50 </articleinfo>
51
52 <toc></toc>
53
54 <sect1><title>Basic principles</title>
55
56 <para>A skin (or theme, the two words have almost the same meaning) for VLC is made of:</para>
57
58 <itemizedlist>
59   <listitem><para>many PNG (Portable Network Graphics) files, for the images of the different states of the controls,</para></listitem>
60   <listitem><para>font files in the TTF (TrueType Font) format,</para></listitem>
61   <listitem><para>a XML file describing the logical structure of the skin (which bitmaps correspond to which controls, where to place buttons, sliders, and so on) and its behaviour (what happens when the user clicks on a button, etc.).</para></listitem>
62 </itemizedlist>
63
64 <para>Those of you who have already made skins for other software should have no
65 difficulty to understand how VLC skins work.</para>
66
67 </sect1>
68
69 <sect1>
70 <title>The bitmaps</title>
71
72 <para>Basically, you need one bitmap file (in PNG format) by state of control. For example, with a <link linkend="Image">Image</link> control you need 1 image, with a <link linkend="Button">Button</link> control you need 3 images (for the up, down and mouseover states). The same bitmap file can be used for many controls, using <link linkend="SubBitmap">sub-bitmaps</link>.</para>
73
74 <para>The PNG format allows setting a transparency mask, which will be used wherever the image needs to be displayed (only non-transparent parts will be drawn). In addition, you can also specify a transparency color in the XML file: the bitmap will be considered as transparent wherever this color appears in the bitmap file.</para>
75
76 <note><para>Both the transparency mask and the transparent color will be taken into acount, so if the transparency mask is correctly set in the bitmap file you need to choose a unused color for the transparency color.</para></note>
77
78 <note><para>Starting from VLC 0.8.5, it is not anymore necessary to use PNG format for the bitmap files: most common formats are supported. Using PNG format is still recommended, for compatibility with older VLC versions.</para></note>
79
80 </sect1>
81
82 <sect1>
83 <title>The XML file</title>
84
85 <para>XML is a markup language, like HTML. It won't be explained here any further, please use Google if you don't know what XML is. You'll see, it is rather easy to understand.</para>
86
87 <para>The XML file used for the VLC skins follows a predefined DTD. You can find this DTD <ulink url="http://trac.videolan.org/vlc/file/trunk/share/skins2/skin.dtd">in VLC SVN</ulink>, and its reading is strongly advised, since it contains the default values used for the parameters. A skin that does not follow the DTD with which VLC was compiled won't be loaded by VLC (and it might even crash it...).</para>
88
89 <para>For a better undestanding of what follows, you should have a look at the DTD <!--(the last version is available on <ulink url="FIXME">TODO</ulink>) -->and/or at an example of valid XML skin<!-- TODO: link to the current DTD -->.</para>
90
91 <para>OK, let's go for an enumeration of the different tags and their attributes:</para>
92
93 <sect2 id="Theme">
94   <title>Theme</title>
95   <para>Main tag, for global attributes</para>
96       <sect3 id="themeversion">
97       <title>version</title>
98       <para>Version of the DTD used when making the skin, such as "2.0" (you can find the version in the <!--TODO: link-->DTD itself). This number might be used in the future to provide a better backward compatibility with older skins.</para>
99       <para><emphasis>Required.</emphasis></para>
100     </sect3>
101     <sect3 id="themetooltipfont">
102       <title>tooltipfont</title>
103       <para>Identifiant of a <link linkend="Font">Font</link> or <link linkend="BitmapFont">BitmapFont</link>, used for the tooltips (beware that any character not present in a <link linkend="BitmapFont">BitmapFont</link> will be printed as a space, so will be invisible). The default value uses a font provided with VLC, so you don't need to provide it with your skin.</para>
104       <para>Default value: defaultfont</para>
105     </sect3>
106     <sect3 id="thememagnet">
107       <title>magnet</title>
108       <para>Allows to select the range of action (in pixels) of magnetism with borders of the screen: when the distance between the border of the screen and an anchor of a window is less than this value, the window will stick to the border. 0 disables magnetism with the screen borders.</para>
109       <para>Default value: 15</para>
110     </sect3>
111     <sect3 id="themealpha">
112       <title>alpha</title>
113       <para>Sets the alpha transparency of the windows. The value must be between 1 (nearly total transparency) and 255 (total opacity). Low values should be avoided.</para>
114 <note><para>This only works if transparency is not disabled in the preferences of the skins2 module.</para></note>
115       <para>Default value: 255</para>
116     </sect3>
117     <sect3 id="thememovealpha">
118       <title>movealpha</title>
119       <para>Sets the alpha transparency of the windows when they are moving. Same range as <link linkend="themealpha">alpha</link>.</para>
120       <note><para>This only works if transparency is not disabled in the preferences of the skins2 module.</para></note>
121       <para>Default value: 255</para>
122     </sect3>
123   </sect2>
124
125 <sect2 id="ThemeInfo">
126   <title>ThemeInfo</title>
127   <para>You can enter here some information about you (but this information is currently unused by VLC...)</para>
128       <sect3 id="themeinfoname">
129       <title>name</title>
130       <para>Skin name. Not supported yet.</para>
131       <para><emphasis>Implied.</emphasis></para>
132     </sect3>
133     <sect3 id="themeinfoauthor">
134       <title>author</title>
135       <para>Author of the skin. Not supported yet.</para>
136       <para><emphasis>Implied.</emphasis></para>
137     </sect3>
138     <sect3 id="themeinfoemail">
139       <title>email</title>
140       <para>Email of the author. Not supported yet.</para>
141       <para><emphasis>Implied.</emphasis></para>
142     </sect3>
143     <sect3 id="themeinfowebpage">
144       <title>webpage</title>
145       <para>Web page in relation with the skin. Not supported yet.</para>
146       <para>Default value: http://www.videolan.org/vlc/</para>
147     </sect3>
148 </sect2>
149
150 <sect2 id="Bitmap">
151   <title>Bitmap</title>
152   <para>Associates a bitmap file (usually in PNG format) with an identifiant (=name) that will be used by the various controls. Obviously, you need one Bitmap tag for each bitmap file you have.</para>
153   <sect3 id="bitmapid">
154     <title>id</title>
155     <para>Identifiant of the bitmap that will be used with controls. Two bitmaps cannot have the same id.</para>
156     <para><emphasis>Required.</emphasis></para>
157   </sect3>
158   <sect3 id="bitmapfile">
159     <title>file</title>
160     <para>Indicates the path and name of the bitmap file used. This path can be absolute (but you should definitely avoid it), or relative to the path of the XML file.</para>
161     <para><emphasis>Required.</emphasis></para>
162   </sect3>
163   <sect3 id="bitmapalphacolor">
164     <title>alphacolor</title>
165     <para>Transparency color of the bitmap. It must be indicated with the following format: "#RRGGBB", where RR stands for the hexadecimal value of the red component, GG for the green one, and BB for the blue one.</para>
166     <note><para>If your PNG file specifies a transparency mask, it will be taken into account too.</para></note>
167     <para>Default value: #000000</para><!--XXX: should we change it into a less often used color?-->
168   </sect3>
169   <sect3 id="bitmapnbframes">
170     <title>nbframes</title>
171     <para>This attribute is needed to define animated bitmaps; it is the number of frames (images) contained in your animation. All the different frames are just images laid vertically in the bitmap. Animated GIFs are not supported at the moment. (since VLC 0.8.5)</para>
172     <para>Default value: 1</para>
173   </sect3>
174   <sect3 id="bitmapfps">
175     <title>fps</title>
176     <para>Only used in animated bitmaps; it is the number of frames (images) per seconds of the animation. (since VLC 0.8.5)</para>
177     <para>Default value: 0</para>
178   </sect3>
179
180 </sect2>
181
182 <sect2 id="SubBitmap">
183   <title>SubBitmap</title>
184   <para>Declares a portion of bitmap, that will be used with controls in the same way as a regular Bitmap. A SubBitmap tag can only be placed inside a <link linkend="Bitmap">Bitmap</link> tag, and references implicitly the same file. SubBitmaps are very convenient when a file contains images for several controls. (This tag was not available before VLC 0.8.5).</para>
185   <sect3 id="subbitmapid">
186     <title>id</title>
187     <para>Identifiant of the portion of bitmap that will be used with controls. It must be unique in the whole skin.</para>
188     <para><emphasis>Required.</emphasis></para>
189   </sect3>
190   <sect3 id="subbitmapx">
191     <title>x</title>
192     <para>Horizontal offset of the sub-bitmap (in pixels), relative to the "parent" bitmap.</para>
193     <para><emphasis>Required.</emphasis></para>
194   </sect3>
195   <sect3 id="subbitmapy">
196     <title>y</title>
197     <para>Vertical offset of the sub-bitmap (in pixels), relative to the "parent" bitmap.</para>
198     <para><emphasis>Required.</emphasis></para>
199   </sect3>
200   <sect3 id="subbitmapwidth">
201     <title>width</title>
202     <para>Width of the sub-bitmap, in pixels.</para>
203     <para><emphasis>Required.</emphasis></para>
204   </sect3>
205   <sect3 id="subbitmapheight">
206     <title>height</title>
207     <para>Height of the SubBitmap, in pixels.</para>
208     <para><emphasis>Required.</emphasis></para>
209   </sect3>
210   <sect3 id="subbitmapnbframes">
211     <title>nbframes</title>
212     <para>Same as in <link linkend="bitmapnbframes">Bitmap</link> tag.</para>
213     <para>Default value: 1</para>
214   </sect3>
215   <sect3 id="subbitmapfps">
216     <title>fps</title>
217     <para>Same as in <link linkend="bitmapfps">Bitmap</link> tag.</para>
218   </sect3>
219
220 </sect2>
221
222 <sect2 id="Font">
223   <title>Font</title>
224   <para>Declares a font to be used in a <link linkend="Text">Text</link> or <link linkend="Playtree">Playtree</link>.</para>
225   <sect3 id="fontid">
226     <title>id</title>
227     <para>Identifiant of the font that will be used with controls.</para>
228     <para><emphasis>Required.</emphasis></para>
229   </sect3>
230   <sect3 id="fontfile">
231     <title>file</title>
232     <para>This is the file containing a TrueType font.</para>
233     <para><emphasis>Required.</emphasis></para>
234   </sect3>
235   <sect3 id="fontsize">
236     <title>size</title>
237     <para>This is the size of the font, in points.</para>
238     <para>Default value: 12</para>
239   </sect3>
240 </sect2>
241
242 <sect2 id="BitmapFont">
243   <title>BitmapFont</title>
244   <para><!--TODO--></para>
245   <sect3 id="bitmapfontid">
246     <title>id</title>
247     <para>Identifiant of the font that will be used with controls.</para>
248     <para><emphasis>Required.</emphasis></para>
249   </sect3>
250   <sect3 id="bitmapfontfile">
251     <title>file</title>
252     <para>This is the file containing a bitmap font, à la Winamp.</para>
253     <para><emphasis>Required.</emphasis></para>
254   </sect3>
255   <sect3 id="bitmapfonttype">
256     <title>type</title>
257     <para>Type of font, one of "digits" or "text".</para>
258     <para>Default value: digits</para>
259   </sect3>
260 </sect2>
261
262 <sect2 id="Window">
263   <title>Window</title>
264   <para>A window that will appear on screen.</para>
265   <sect3 id="windowid">
266     <title>id</title>
267     <para>Name of the window (it may be used for actions). Two windows cannot have the same id.</para>
268     <para>Default value: none</para>
269   </sect3>
270   <sect3 id="windowvisible">
271     <title>visible</title>
272     <para>Indicates whether the window should appear when VLC is started. Since VLC remembers the skin windows position and visibility, this attribute will only be used the first time the skin is started.</para>
273     <para>Default value: true</para>
274   </sect3>
275   <sect3 id="windowx">
276     <title>x</title>
277     <para>Initial left position of the window.</para>
278     <para>Default value: 0</para>
279   </sect3>
280   <sect3 id="windowy">
281     <title>y</title>
282     <para>Initial top position of the window.</para>
283     <para>Default value: 0</para>
284   </sect3>
285   <sect3 id="windowdragdrop">
286     <title>dragdrop</title>
287     <para>Indicates whether drag and drop of media files is allowed on this window.</para>
288     <para>Default value: true</para>
289   </sect3>
290   <sect3 id="windowplayondrop">
291     <title>playondrop</title>
292     <para>Indicates whether a dropped file is played directly (true) or only enqueued (false). This attribute has no effect if <link linkend="windowdragdrop">dragdrop</link> is set to "false".</para>
293     <para>Default value: true</para>
294   </sect3>
295 </sect2>
296
297 <sect2 id="Layout">
298   <title>Layout</title>
299   <para>A layout is one aspect of a window, i.e. a set of controls and anchors. A window can have many layouts, but only one will be visible at any time.</para>
300   <sect3 id="layoutid">
301     <title>id</title>
302     <para>Name of the layout (it may be used for actions). Two layouts cannot have the same id.</para>
303     <para>Default value: none</para>
304   </sect3>
305   <sect3 id="layoutwidth">
306     <title>width</title>
307     <para><!--TODO: calculate it in VLC :)-->Initial width of the layout. This value is required since VLC is not (yet?) able to calculate it using the sizes and positions of the controls.</para>
308     <para><emphasis>Required.</emphasis></para>
309   </sect3>
310   <sect3 id="layoutheight">
311     <title>height</title>
312     <para><!--TODO: calculate it in VLC :)-->Initial height of the layout. This value is required since VLC is not (yet?) able to calculate it using the sizes and positions of the controls.</para>
313     <para><emphasis>Required.</emphasis></para>
314   </sect3>
315   <sect3 id="minwidth">
316     <title>minwidth</title>
317     <para>Minimum width of the layout. This value is only used when resizing the layout. If this value is set to "-1", the initial width (as specified by the <link linkend="layoutwidth">width</link> attribute) will be used as minimum width.</para>
318     <para>Default value: -1</para>
319   </sect3>
320   <sect3 id="maxwidth">
321     <title>maxwidth</title>
322     <para>Maximum width of the layout. This value is only used when resizing the layout. If this value is set to "-1", the initial width (as specified by the <link linkend="layoutwidth">width</link> attribute) will be used as maximum width.</para>
323     <para>Default value: -1</para>
324   </sect3>
325   <sect3 id="minheight">
326     <title>minheight</title>
327     <para>Minimum height of the layout. This value is only used when resizing the layout. If this value is set to "-1", the initial height (as specified by the <link linkend="layoutheight">height</link> attribute) will be used as minimum height.</para>
328     <para>Default value: -1</para>
329   </sect3>
330   <sect3 id="maxheight">
331     <title>maxheight</title>
332     <para>Maximum height of the layout. This value is only used when resizing the layout. If this value is set to "-1", the initial height (as specified by the <link linkend="layoutheight">height</link> attribute) will be used as maximum height.</para>
333     <para>Default value: -1</para>
334   </sect3>
335 </sect2>
336
337 <sect2 id="Group">
338   <title>Group</title>
339   <para>Add an offset to the elements it contains. A Group is only supposed to ease the job of the skin designer, who can adjust the position of a group of controls without modifying all the coordinates, but you can ignore it if you want (only one Group is necessary, inside the <link linkend="Layout">Layout</link> tag). Group tags can be nested. Note that Group elements are deprecated, since <link linkend="Panel">Panel</link> elements are more powerful.</para>
340   <sect3 id="groupx">
341     <title>x</title>
342     <para>Horizontal offset, relative to the container box (see the <link linkend="layoutmodel">Layout model</link> for more details).</para>
343     <para>Default value: 0</para>
344   </sect3>
345   <sect3 id="groupy">
346     <title>y</title>
347     <para>Vertical offset, relative to the container box (see the <link linkend="layoutmodel">Layout model</link> for more details).</para>
348     <para>Default value: 0</para>
349   </sect3>
350 </sect2>
351
352 <sect2 id="Panel">
353   <title>Panel</title>
354   <para>A Panel can be seen as an enhanced <link linkend="Layout">Group</link>. It also adds an offset to the elements it contains, but in addition it becomes their reference for the lefttop, rightbottom, xkeepratio and ykeepratio attributes. Panel tags can be nested. Since VLC 0.9.0.</para>
355   <para>See the <link linkend="commattr">common attributes</link>.</para>
356   <sect3 id="panelx">
357     <title>x</title>
358     <para>Same as the <link linkend="x">x</link> attribute of the <link linkend="commattr">common attributes</link>.</para>
359   </sect3>
360   <sect3 id="panely">
361     <title>y</title>
362     <para>Same as the <link linkend="y">y</link> attribute of the <link linkend="commattr">common attributes</link>.</para>
363   </sect3>
364   <sect3 id="panelwidth">
365     <title>width</title>
366     <para>Initial width of this container box (see the <link linkend="layoutmodel">Layout model</link> for more details).</para>
367   </sect3>
368   <sect3 id="panelheight">
369     <title>height</title>
370     <para>Initial height of this container box (see the <link linkend="layoutmodel">Layout model</link> for more details).</para>
371   </sect3>
372   <sect3 id="panellefttop">
373     <title>lefttop</title>
374     <para>Same as the <link linkend="lefttop">lefttop</link> attribute of the <link linkend="commattr">common attributes</link>.</para>
375   </sect3>
376   <sect3 id="panelrightbottom">
377     <title>rightbottom</title>
378     <para>Same as the <link linkend="rightbottom">rightbottom</link> attribute of the <link linkend="commattr">common attributes</link>.</para>
379   </sect3>
380   <sect3 id="panelxkeepratio">
381     <title>xkeepratio</title>
382     <para>Same as the <link linkend="xkeepratio">xkeepratio</link> attribute of the <link linkend="commattr">common attributes</link>.</para>
383   </sect3>
384   <sect3 id="panelykeepratio">
385     <title>ykeepratio</title>
386     <para>Same as the <link linkend="ykeepratio">ykeepratio</link> attribute of the <link linkend="commattr">common attributes</link>.</para>
387   </sect3>
388 </sect2>
389
390 <sect2 id="Anchor">
391   <title>Anchor</title>
392   <para>Create a "magnetic point" (or curve) in the current window. If an anchor of another window enters in the range of action of this anchor, the 2 anchors will automatically be on the same place, and the windows are "sticked". Each anchor has a priority (<link linkend="anchorpriority">priority</link> attribute), and the anchor with the highest priority is the winner, which means that when moving its window all the other anchored windows will move too. To break the effect of 2 anchored windows, you need to move the window whose anchor has the lower priority.</para>
393   <sect3 id="anchorx">
394     <title>x</title>
395     <para>Is it really necessary to explain?</para>
396     <para>Default value: 0</para>
397   </sect3>
398   <sect3 id="anchory">
399     <title>y</title>
400     <para>...</para>
401     <para>Default value: 0</para>
402   </sect3>
403   <sect3 id="anchorlefttop">
404     <title>lefttop</title>
405     <para>Indicate to which corner of the Layout the top-left-hand corner of this anchor is attached, in case of resizing. Possible values are 'lefttop', 'leftbottom', 'righttop' and 'rightbottom'. Available since VLC 0.8.6.</para>
406     <para>Note that there is no "rightbottom" attribute for the anchors (contrarily to normal controls), because an anchor is not resizable (even when the anchor is not ponctual and follows a Bezier curve).</para>
407     <para>Default value: lefttop</para>
408   </sect3>
409   <sect3 id="anchorpriority">
410     <title>priority</title>
411     <para>Priority of anchor (see the previous description).</para>
412     <para><emphasis>Required.</emphasis></para>
413   </sect3>
414   <sect3 id="anchorpoints">
415     <title>points</title>
416     <para>Points defining the <link linkend="bezier">Bezier curve</link> followed by the anchor.</para>
417     <note><para>You don't need to change this parameter if all you want is a ponctual anchor.</para></note>
418     <para>Default value: (0,0)</para>
419   </sect3>
420   <sect3 id="anchorrange">
421     <title>range</title>
422     <para>Range of action of the anchor, in pixels.</para>
423     <para>Default value: 10</para>
424   </sect3>
425 </sect2>
426
427
428 <sect2 id="commattr">
429   <title>Common attributes</title>
430   <para>The following attributes are common to all the controls (Image, Button, Checkbox, Text, Slider, RadialSlider, Playlist, Playtree, Video)</para>
431   <sect3 id="attrid">
432     <title>id</title>
433     <para>Identifiant of the control. Currently unused.</para>
434     <para>Default value: none</para>
435   </sect3>
436   <sect3 id="visible">
437     <title>visible</title>
438     <para>See <link linkend="boolexpr">Boolean expressions</link>.</para>
439     <para>Default value: true</para>
440   </sect3>
441   <sect3 id="x">
442     <title>x</title>
443     <para>Horizontal offset of the control, relative to the container box (see the <link linkend="layoutmodel">Layout model</link>) or to the parent <link linkend="Group">Group</link>.</para>
444     <para>Default value: 0</para>
445   </sect3>
446   <sect3 id="y">
447     <title>y</title>
448     <para>Vertical offset of the control, relative to the container box (see the <link linkend="layoutmodel">Layout model</link>) or to the parent <link linkend="Group">Group</link>.</para>
449     <para>Default value: 0</para>
450   </sect3>
451   <sect3 id="lefttop">
452     <title>lefttop</title>
453     <para>Indicate to which corner of the container box the top-left-hand corner of this control is attached, in case of resizing. Possible values are 'lefttop', 'leftbottom', 'righttop' and 'rightbottom'. See the <link linkend="layoutmodel">Layout model</link> for more details.</para>
454     <para>Default value: lefttop</para>
455   </sect3>
456   <sect3 id="rightbottom">
457     <title>rightbottom</title>
458     <para>Indicate to which corner of the container box the bottom-right-hand corner of this control is attached, in case of resizing. See the <link linkend="layoutmodel">Layout model</link> for more details.</para>
459     <para>Default value: lefttop</para>
460   </sect3>
461   <sect3 id="xkeepratio">
462     <title>xkeepratio</title>
463     <para>When set to true, the behaviour of the horizontal resizing is changed. Instead of taking into account the <link linkend="lefttop">lefttop</link> and <link linkend="rightbottom">rightbottom</link> attributes to determine how the control will be moved/resized, only its initial position inside the container box matters. For example, if initially the space to the left of the control is twice as big as the one to its right, this will stay the same during any horizontal resizing. The width of the control stays constant.</para>
464     <para>This attribute can be particularly useful to keep a control centered in the container box, without resizing it (to resize it, you would rather use the lefttop/rightbottom attributes). See the <link linkend="layoutmodel">Layout model</link> for more details. Available since VLC 0.8.6.</para>
465     <para>Default value: false</para>
466   </sect3>
467   <sect3 id="ykeepratio">
468     <title>ykeepratio</title>
469     <para>When set to true, the behaviour of the vertical resizing is changed. Instead of taking into account the <link linkend="lefttop">lefttop</link> and <link linkend="rightbottom">rightbottom</link> attributes to determine how the control will be moved/resized, only its initial position inside the <link linkend="Layout">Layout</link> matters. For example, if initially the space to the top of the control is twice as big as the one to its bottom, this will stay the same during any vertical resizing. The height of the control stays constant.</para>
470     <para>This attribute can be particularly useful to keep a control centered in the container box, without resizing it (to resize it, you would rather use the lefttop/rightbottom attributes). See the <link linkend="layoutmodel">Layout model</link> for more details. Available since VLC 0.8.6.</para>
471     <para>Default value: false</para>
472   </sect3>
473   <sect3 id="help">
474     <title>help</title>
475     <para>Help text for the current control. The variable '$H' will be expanded to this value when the mouse hovers the current control (see <link linkend="textvars">Text variables</link>).</para>
476     <para>Default value: </para>
477   </sect3>
478 </sect2>
479
480 <sect2 id="Image">
481   <title>Image</title>
482   <para>Create a simple image. Particularly useful for backgrounds.</para>
483   <para>See the <link linkend="commattr">Common attributes</link>.</para>
484   <sect3 id="image">
485     <title>image</title>
486     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>.</para>
487     <para><emphasis>Required.</emphasis></para>
488   </sect3>
489   <sect3 id="imageresize">
490     <title>resize</title>
491     <para>Since VLC 0.8.2. Specify the behaviour of the image when it is resized. Possible values are 'mosaic' (the image is repeated as many times as necessary to reach the wanted dimensions) and 'scale' (the image is actually rescaled). Beware that the 'scale' behaviour is much slower than the 'mosaic' one, so make sure to use it only when it's really needed.</para>
492     <para>Default value: mosaic.</para>
493   </sect3>
494   <sect3 id="imageaction">
495     <title>action</title>
496     <para>Action triggered by a click on the control. Possible values are 'move', to move the window, 'resizeE', to resize horizontally, 'resizeS' to resize vertically, and 'resizeSE' to resize both horizontally and vertically. Mnemonics: S, E and SE stand for South, East, and South-East. The 'resizeS' and 'resizeE' actions are available since VLC 0.8.5 only.</para>
497     <para>Default value: none</para>
498   </sect3>
499   <sect3 id="imageaction2">
500     <title>action2</title>
501     <para>Action triggered by a double-click on the control. See <link linkend="actions">Actions</link> for a list of possible actions. (Since VLC 0.8.5).</para>
502     <para>Default value: none</para>
503   </sect3>
504 </sect2>
505
506 <sect2 id="Button">
507   <title>Button</title>
508   <para>Create a button.</para>
509   <para>See the <link linkend="commattr">common attributes</link>.</para>
510   <sect3 id="buttonup">
511     <title>up</title>
512     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the button is up.</para>
513     <para><emphasis>Required.</emphasis></para>
514   </sect3>
515   <sect3 id="buttondown">
516     <title>down</title>
517     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the button is down.</para>
518     <para>Default value: none</para>
519   </sect3>
520   <sect3 id="buttonover">
521     <title>over</title>
522     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the mouse is over the button.</para>
523     <para>Default value: none</para>
524   </sect3>
525   <sect3 id="buttonaction">
526     <title>action</title>
527     <para>Action executed when the button is clicked. See <link linkend="actions">Actions</link> for a list of possible actions.</para>
528     <para>Default value: none</para>
529   </sect3>
530 </sect2>
531
532 <sect2 id="Checkbox">
533   <title>Checkbox</title>
534   <para>Create a checkbox, i.e. a button with 2 states (checked/unchecked). So you need 6 images for a full-featured checkbox: each state has a basic image ('up' state), an image for the control being hovered by the mouse ('over' state) and an image corresponding to a click not yet released ('down' state). If you supply only the basic images, the other ones will be identical.</para>
535   <para>See the <link linkend="commattr">common attributes</link>.</para>
536   <sect3 id="up1">
537     <title>up1</title>
538     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the checkbox is up in the first state.</para>
539     <para><emphasis>Required.</emphasis></para>
540   </sect3>
541   <sect3 id="down1">
542     <title>down1</title>
543     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the checkbox is down in the first state.</para>
544     <para>Default value: none</para>
545   </sect3>
546   <sect3 id="over1">
547     <title>over1</title>
548     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the mouse is over the checkbox in the first state.</para>
549     <para>Default value: none</para>
550   </sect3>
551   <sect3 id="up2">
552     <title>up2</title>
553     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the checkbox is up in the second state.</para>
554     <para><emphasis>Required.</emphasis></para>
555   </sect3>
556   <sect3 id="down2">
557     <title>down2</title>
558     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the checkbox is down in the second state.</para>
559     <para>Default value: none</para>
560   </sect3>
561   <sect3 id="over2">
562     <title>over2</title>
563     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the mouse is over the checkbox in the second state.</para>
564     <para>Default value: none</para>
565   </sect3>
566   <sect3 id="state">
567     <title>state</title>
568     <para><link linkend="boolexpr">Boolean expression</link> specifying the state of the checkbox: if the expression resolves to 'false', the first state will be used, and if it resolves to 'true' the second state will be used. Example for a checkbox showing/hiding a window whose <link linkend="windowid">id</link> is "playlist_window": state="playlist_window.isVisible" (or state="not playlist_window.isVisible", depending on the states you chose).</para>
569     <para><emphasis>Required.</emphasis></para>
570   </sect3>
571   <sect3 id="action1">
572     <title>action1</title>
573     <para>Action executed when the checkbox is clicked (state 1 to state 2). See <link linkend="actions">Actions</link> for a list of possible actions.</para>
574     <para>Default value: none</para>
575   </sect3>
576   <sect3 id="action2">
577     <title>action2</title>
578     <para>Action executed when the checkbox is clicked (state 2 to state 1). See <link linkend="actions">Actions</link> for a list of possible actions.</para>
579     <para>Default value: none</para>
580   </sect3>
581   <sect3 id="tooltiptext1">
582     <title>tooltiptext1</title>
583     <para>Tooltip associated with the checkbox in state 1. See also <link linkend="textvars">Text variables</link>.</para>
584     <para>Default value: </para>
585   </sect3>
586   <sect3 id="tooltiptext2">
587     <title>tooltiptext2</title>
588     <para>Tooltip associated with the checkbox in state 2. See also <link linkend="textvars">Text variables</link>.</para>
589     <para>Default value: </para>
590   </sect3>
591 </sect2>
592
593 <sect2 id="Text">
594   <title>Text</title>
595   <para>Control to display some text.</para>
596   <para>See the <link linkend="commattr">common attributes</link>.</para>
597   <sect3 id="textfont">
598     <title>font</title>
599     <para>Identifiant of a <link linkend="Font">Font</link> or <link linkend="BitmapFont">BitmapFont</link> (beware that any character not present in the <link linkend="BitmapFont">BitmapFont</link> will be printed as a space, so will be invisible).</para>
600     <para><emphasis>Required.</emphasis></para>
601   </sect3>
602   <sect3 id="texttext">
603     <title>text</title>
604     <para>Text to display. See also <link linkend="textvars">Text variables</link>.</para>
605     <para>Default value: </para>
606   </sect3>
607   <sect3 id="textcolor">
608     <title>color</title>
609     <para>Color of the text, using the #RRGGBB format.</para>
610     <para>Default value: #000000</para>
611   </sect3>
612   <sect3 id="textwidth">
613     <title>width</title>
614     <para>Width of the text in pixels. If set to "0", the width is automatically calculated to fit with the current text.<!--XXX: Probably false...--></para>
615     <para>Default value: 0</para>
616   </sect3>
617   <sect3 id="textalignment">
618     <title>alignment</title>
619     <para>Alignment of the text inside the control. Possible values are 'left', 'center' and 'right'. The 'width' and 'center' alignments are computed using the width of the control (as given by the <link linkend="textwidth">width</link> attribute). Available since VLC 0.8.5.</para>
620     <para>Default value: left</para>
621   </sect3>
622   <sect3 id="textscrolling">
623     <title>scrolling</title>
624     <para>Scrolling behaviour of the text (only when it doesn't fit in the <link linkend="textwidth">width</link> of the control). Possible values are 'auto', 'manual' and 'none'. If this attribute is set to 'auto', the text automatically starts scrolling. The user can drag the text, and click on it to start/stop the scrolling. If this attribute is set to 'manual', the text only scrolls when dragged by the user. If this attribute is set to 'none', no scrolling is possible at all. Available since VLC 0.8.5.</para>
625     <para>Default value: auto</para>
626   </sect3>
627 </sect2>
628
629 <sect2 id="Slider">
630   <title>Slider</title>
631   <para>Create a slider. This element can be used alone, or can contain a <link linkend="SliderBackground">SliderBackground</link> element.</para>
632   <para>See the <link linkend="commattr">common attributes</link>.</para>
633   <sect3 id="sliderup">
634     <title>up</title>
635     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the slider cursor is up.</para>
636     <para><emphasis>Required.</emphasis></para>
637   </sect3>
638   <sect3 id="sliderdown">
639     <title>down</title>
640     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the slider cursor is down.</para>
641     <para>Default value: none</para>
642   </sect3>
643   <sect3 id="sliderover">
644     <title>over</title>
645     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used when the mouse is over the slider cursor.</para>
646     <para>Default value: none</para>
647   </sect3>
648   <sect3 id="sliderpoints">
649     <title>points</title>
650     <para>Points defining the <link linkend="bezier">Bezier curve</link> followed by the slider cursor.</para>
651     <para>Default value: none</para>
652   </sect3>
653   <sect3 id="sliderthickness">
654     <title>thickness</title>
655     <para>Thickness of the slider curve. This attribute is used to determine whether the mouse is over the slider (hence whether a mouse click will have an effect on the cursor position).</para>
656     <para>Default value: 10</para>
657   </sect3>
658   <sect3 id="slidervalue">
659     <title>value</title>
660     <para>Variable controlled by the slider. This must be a <link linkend="percent">percentage variable</link>, e.g "volume" or "time" (only exception: the <link linkend="Slider">Slider</link> defined inside the <link linkend="Playtree">Playtree</link> tag does not need to set this attribute).</para>
661     <para>Default value: none</para>
662   </sect3>
663   <sect3 id="slidertooltiptext">
664     <title>tooltiptext</title>
665     <para>Tooltip associated with the slider. See also <link linkend="textvars">Text variables</link>.</para>
666     <para>Default value: </para>
667   </sect3>
668 </sect2>
669
670
671 <sect2 id="SliderBackground">
672   <title>SliderBackground</title>
673   <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>
674   <para>See the <link linkend="commattr">common attributes</link>.</para>
675   <sect3 id="sbg_image">
676     <title>image</title>
677     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>; image containing the sub-images used to draw the background of the slider.</para>
678     <para><emphasis>Required.</emphasis></para>
679   </sect3>
680   <sect3 id="nbhoriz">
681     <title>nbhoriz</title>
682     <para>Number of sub-images in the horizontal direction.</para>
683     <para>Default value: 1</para>
684   </sect3>
685   <sect3 id="nbvert">
686     <title>nbvert</title>
687     <para>Number of sub-images in the vertical direction.</para>
688     <para>Default value: 1</para>
689   </sect3>
690   <sect3 id="padhoriz">
691     <title>padhoriz</title>
692     <para>Horizontal padding: number of unused pixel rows between two sub-images.</para>
693     <para>Default value: 0</para>
694   </sect3>
695   <sect3 id="padvert">
696     <title>padvert</title>
697     <para>Vertical padding: number of unused pixel lines between two sub-images.</para>
698     <para>Default value: 0</para>
699   </sect3>
700 </sect2>
701
702 <sect2 id="RadialSlider">
703   <title>RadialSlider</title>
704   <para>Create a circular slider from a list of images with the different possible positions.</para>
705   <para>See the <link linkend="commattr">common attributes</link>.</para>
706   <sect3 id="sequence">
707     <title>sequence</title>
708     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link> containing the list of images of the different positions of the slider, concatenated vertically.</para>
709     <para><emphasis>Required.</emphasis></para>
710   </sect3>
711   <sect3 id="nbimages">
712     <title>nbimages</title>
713     <para>Number of elementary images contained in the sequence.</para>
714     <para><emphasis>Required.</emphasis></para>
715   </sect3>
716   <sect3 id="minangle">
717     <title>minangle</title>
718     <para>Minimum angle of the rotation, corresponding to 0%.</para>
719     <para>Default value: 0</para>
720   </sect3>
721   <sect3 id="maxangle">
722     <title>maxangle</title>
723     <para>Maximum angle of the rotation, corresponding to 100%.</para>
724     <para>Default value: 360</para>
725   </sect3>
726   <sect3 id="radialslidervalue">
727     <title>value</title>
728     <para>Variable controlled by the slider. This must be a <link linkend="percent">percentage variable</link>, e.g "volume" or "time".</para>
729     <para>Default value: none</para>
730   </sect3>
731   <sect3 id="radialslidertooltiptext">
732     <title>tooltiptext</title>
733     <para>Tooltip associated with the slider. See also <link linkend="textvars">Text variables</link>.</para>
734     <para>Default value: </para>
735   </sect3>
736 </sect2>
737
738 <sect2 id="Video">
739   <title>Video</title>
740   <para>Control containing a video. This allows skinable video outputs!</para>
741   <note><para>This control is still under development and its behaviour may change a lot in the future.</para></note>
742   <sect3 id="videowidth">
743     <title>width</title>
744     <para>Initial width of the control, in pixels.<!--XXX: cannot be deduced?--></para>
745     <para>Default value: 0</para>
746   </sect3>
747   <sect3 id="videoheight">
748     <title>height</title>
749     <para>Initial height of the control, in pixels.<!--XXX: cannot be deduced?--></para>
750     <para>Default value: 0</para>
751   </sect3>
752   <sect3 id="videoautoresize">
753     <title>autoresize</title>
754     <para>Indicate whether the layout should be automatically resized to fit the dimensions of the played video.</para>
755     <para>Default value: true</para>
756   </sect3>
757 </sect2>
758
759 <sect2 id="Playlist">
760  <title>Playlist</title>
761  <para>This tag used to create a playlist. This tag is deprecated, you should now use <link linkend="Playtree">Playtree</link></para>
762 </sect2>
763
764 <sect2 id="Playtree">
765   <title>Playtree</title>
766   <para>Create a playlist. This tag must contain a <link linkend="Slider">Slider</link> tag (to allow scrolling in the playlist).</para>
767   <para>See the <link linkend="commattr">common attributes</link>.</para>
768   <sect3 id="playlistwidth">
769     <title>width</title>
770     <para>Width of the playlist, in pixels. If playlist items are wider, the end of the name will be replaced with '...'.</para>
771     <para>Default value: 0</para>
772   </sect3>
773   <sect3 id="playlistheight">
774     <title>height</title>
775     <para>Height of the playlist, in pixels.</para>
776     <para>Default value: 0</para>
777   </sect3>
778   <sect3 id="playlistfont">
779     <title>font</title>
780     <para>Identifiant of a <link linkend="Font">Font</link> tag.</para>
781     <para><emphasis>Required.</emphasis></para>
782   </sect3>
783   <sect3 id="var">
784     <title>var</title>
785     <para>Type of playlist. Currently, only "playlist" is recognized, so don't bother with this attribute :)</para>
786     <para>Default value: playlist</para>
787   </sect3>
788   <sect3 id="bgimage">
789     <title>bgimage</title>
790     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link>, used as the background image. When no bitmap is specified, the background will be filled using the <link linkend="bgcolor1">bgcolor1</link> and <link linkend="bgcolor2">bgcolor2</link> attributes.</para>
791     <para>Default value: none</para>
792   </sect3>
793   <sect3 id="fgcolor">
794     <title>fgcolor</title>
795     <para>Foreground color of the playlist items.</para>
796     <para>Default value: #000000</para>
797   </sect3>
798   <sect3 id="playcolor">
799     <title>playcolor</title>
800     <para>Foreground color of the item currently played.</para>
801     <para>Default value: #FF0000</para>
802   </sect3>
803   <sect3 id="selcolor">
804     <title>selcolor</title>
805     <para>Background color of selected items.</para>
806     <para>Default value: #0000FF</para>
807   </sect3>
808   <sect3 id="bgcolor1">
809     <title>bgcolor1</title>
810     <para>Background color for odd playlist items. This attribute is ignored if the <link linkend="bgimage">bgimage</link> one is used.</para>
811     <para>Default value: #FFFFFF</para>
812   </sect3>
813   <sect3 id="bgcolor2">
814     <title>bgcolor2</title>
815     <para>Background color for even playlist items. This attribute is ignored if the <link linkend="bgimage">bgimage</link> one is used.</para>
816     <para>Default value: #FFFFFF</para>
817   </sect3>
818   <sect3 id="flat">
819     <title>flat</title>
820     <para>Boolean to indicate whether the playlist should use the tree structure or be completely "flat" (only show the leafs of the tree).</para>
821     <para>A flat playtree will work like old-style playlists.</para>
822     <para>Default value: false</para>
823   </sect3>
824   <sect3 id="itemimage">
825     <title>itemimage</title>
826     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link> shown to the left of a leaf (playlist item).</para>
827  </sect3>
828   <sect3 id="openimage">
829     <title>openimage</title>
830     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link> shown to the left of a node, when it is expanded.</para>
831  </sect3>
832  <sect3 id="closedimage">
833     <title>closedimage</title>
834     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link> shown to the left of a node, when it is retracted.</para>
835  </sect3>
836 </sect2>
837
838 </sect1>
839
840 <sect1 id="actions">
841 <title>Actions</title>
842
843 <para>There is a predefined list of actions:</para>
844
845 <itemizedlist>
846   <listitem><para>
847     <emphasis>none</emphasis>: Do nothing
848   </para></listitem>
849   <listitem><para>
850     <emphasis>dialogs.changeSkin()</emphasis>: Show a dialog box to load a new skin. This does the same as the predefined hotkey Ctrl+S.
851   </para></listitem>
852   <listitem><para>
853     <emphasis>dialogs.fileSimple()</emphasis>: Show the simple "Open File" dialog box.
854   </para></listitem>
855   <listitem><para>
856     <emphasis>dialogs.file()</emphasis>: Show the "Open File" dialog box, with many options (stream output, subtitles, etc...).
857   </para></listitem>
858   <listitem><para>
859     <emphasis>dialogs.directory()</emphasis>: Show the "Open Directory" dialog box (new after VLC 0.8.2).
860   </para></listitem>
861   <listitem><para>
862     <emphasis>dialogs.disc()</emphasis>: Show the "Open Disc" dialog box.
863   </para></listitem>
864   <listitem><para>
865     <emphasis>dialogs.net()</emphasis>: Show the "Open Network Stream" dialog box.
866   </para></listitem>
867   <listitem><para>
868     <emphasis>dialogs.messages()</emphasis>: Show the "Meessage" dialog box (which gives error/warning/debug messages).
869   </para></listitem>
870   <listitem><para>
871     <emphasis>dialogs.prefs()</emphasis>: Show the "Preferences" dialog box.
872   </para></listitem>
873   <listitem><para>
874     <emphasis>dialogs.fileInfo()</emphasis>: Show the "File Info" dialog box.
875   </para></listitem>
876   <listitem><para>
877     <emphasis>dialogs.playlist()</emphasis>: Show the "standard" (not skinned) playlist dialog (since VLC 0.8.6).
878   </para></listitem>
879   <listitem><para>
880     <emphasis>dialogs.streamingWizard()</emphasis>: Show the "Streaming Wizard" dialog box (new after VLC 0.8.2).
881   </para></listitem>
882   <listitem><para>
883     <emphasis>dialogs.popup()</emphasis>: Show the full popup menu, (already available with a right-click on a <link linkend="Image">Image</link> control).
884   </para></listitem>
885   <listitem><para>
886     <emphasis>dialogs.audioPopup()</emphasis>: Show the audio settings popup menu (since VLC 0.8.6).
887   </para></listitem>
888    <listitem><para>
889     <emphasis>dialogs.videoPopup()</emphasis>: Show the video settings popup menu (since VLC 0.8.6).
890   </para></listitem>
891   <listitem><para>
892     <emphasis>dialogs.miscPopup()</emphasis>: Show a popup menu containing playback control and general options (since VLC 0.8.6).
893   </para></listitem>
894   <listitem><para>
895     <emphasis>equalizer.enable()</emphasis>: Enable the equalizer audio filter (since VLC 0.8.5).
896   </para></listitem>
897   <listitem><para>
898     <emphasis>equalizer.disable()</emphasis>: Disable the equalizer audio filter (since VLC 0.8.5).
899   </para></listitem>
900   <listitem><para>
901     <emphasis>vlc.play()</emphasis>: Play the current playlist item.
902   </para></listitem>
903   <listitem><para>
904     <emphasis>vlc.pause()</emphasis>: Pause the current playlist item.
905   </para></listitem>
906   <listitem><para>
907     <emphasis>vlc.stop()</emphasis>: Stop the current playlist item.
908   </para></listitem>
909   <listitem><para>
910     <emphasis>vlc.faster()</emphasis>: Play the current playlist item faster.
911   </para></listitem>
912   <listitem><para>
913     <emphasis>vlc.slower()</emphasis>: Play the current playlist item slower.
914   </para></listitem>
915   <listitem><para>
916     <emphasis>vlc.mute()</emphasis>: Toggle mute/un-mute.
917   </para></listitem>
918   <listitem><para>
919     <emphasis>vlc.volumeUp()</emphasis>: Increase the volume (since VLC 0.8.2).
920   </para></listitem>
921   <listitem><para>
922     <emphasis>vlc.volumeDown()</emphasis>: Reduce the volume (since VLC 0.8.2).
923   </para></listitem>
924   <listitem><para>
925     <emphasis>vlc.fullscreen()</emphasis>: Toggle the fullscreen mode.
926   </para></listitem>
927   <listitem><para>
928     <emphasis>vlc.snapshot()</emphasis>: Take a snapshot (since VLC 0.8.5).
929   </para></listitem>
930   <listitem><para>
931     <emphasis>vlc.onTop()</emphasis>: Toggle the "Always on top" status (since VLC 0.8.0).
932   </para></listitem>
933   <listitem><para>
934     <emphasis>vlc.minimize()</emphasis>: Minimize VLC (since VLC 0.8.0)
935   </para></listitem>
936   <listitem><para>
937     <emphasis>vlc.quit()</emphasis>: Quit VLC.
938   </para></listitem>
939   <listitem><para>
940     <emphasis>playlist.add()</emphasis>: Add a new item to the playlist.
941   </para></listitem>
942   <listitem><para>
943     <emphasis>playlist.del()</emphasis>: Remove the selected items from the playlist.
944   </para></listitem>
945   <listitem><para>
946     <emphasis>playlist.next()</emphasis>: Go to the next playlist item.
947   </para></listitem>
948   <listitem><para>
949     <emphasis>playlist.previous()</emphasis>: Go to the previous playlist item.
950   </para></listitem>
951   <listitem><para>
952     <emphasis>playlist.sort()</emphasis>: Sort the playlist alphabetically.
953   </para></listitem>
954   <listitem><para>
955     <emphasis>playlist.setRandom(true)</emphasis>: Play the playlist items in random order.
956   </para></listitem>
957   <listitem><para>
958     <emphasis>playlist.setRandom(false)</emphasis>: Play the playlist items in the playlist order.
959   </para></listitem>
960   <listitem><para>
961     <emphasis>playlist.setLoop(true)</emphasis>: Loop at playlist end.
962   </para></listitem>
963   <listitem><para>
964     <emphasis>playlist.setLoop(false)</emphasis>: Do not loop at playlist end.
965   </para></listitem>
966   <listitem><para>
967     <emphasis>playlist.setRepeat(true)</emphasis>: Repeat the current playlist item (since VLC 0.8.0).
968   </para></listitem>
969   <listitem><para>
970     <emphasis>playlist.setRepeat(false)</emphasis>: Stop repeating the current playlist item (since VLC 0.8.0).
971   </para></listitem>
972   <listitem><para>
973     <emphasis>playlist.load()</emphasis>: Load an external playlist file (since VLC 0.8.0).
974   </para></listitem>
975   <listitem><para>
976     <emphasis>playlist.save()</emphasis>: Save the current playlist (since VLC 0.8.0).
977   </para></listitem>
978   <listitem id="dvdactions"><para>
979     <emphasis>dvd.nextTitle()</emphasis>: Go to the next title of the DVD (since VLC 0.8.5).
980   </para></listitem>
981   <listitem><para>
982     <emphasis>dvd.previousTitle()</emphasis>: Go to the previous title of the DVD (since VLC 0.8.5).
983   </para></listitem>
984   <listitem><para>
985     <emphasis>dvd.nextChapter()</emphasis>: Go to the next chapter of the DVD (since VLC 0.8.5).
986   </para></listitem>
987   <listitem><para>
988     <emphasis>dvd.previousChapter()</emphasis>: Go to the previous chapter of the DVD (since VLC 0.8.5).
989   </para></listitem>
990   <listitem><para>
991     <emphasis>dvd.rootMenu()</emphasis>: Go to the root menu of the DVD (since VLC 0.8.5).
992   </para></listitem>
993   <listitem><para>
994     <emphasis>WindowID.show()</emphasis>: Show the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID'.
995   </para></listitem>
996   <listitem><para>
997     <emphasis>WindowID.hide()</emphasis>: Hide the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID'.
998   </para></listitem>
999   <listitem><para>
1000     <emphasis>WindowID.maximize()</emphasis>: Maximize the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID'. Since VLC 0.9.0.
1001   </para></listitem>
1002   <listitem><para>
1003     <emphasis>WindowID.unmaximize()</emphasis>: Unmaximize the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID'. Since VLC 0.9.0.
1004   </para></listitem>
1005   <listitem><para>
1006     <emphasis>WindowID.setLayout(LayoutID)</emphasis>: Change the layout of the <link linkend="Window">Window</link> whose <link linkend="windowid">id</link> attribute is 'WindowID', using the <link linkend="Layout">Layout</link> whose <link linkend="layoutid">id</link> attribute is 'LayoutID'.
1007   </para></listitem>
1008 </itemizedlist>
1009
1010 <para>It is possible to run several actions at once, by separating them with ';'. Example: action="playlist_id.hide(); main_window_id.setLayout(main_layout)"</para>
1011
1012 </sect1>
1013
1014 <sect1 id="textvars">
1015 <title>Text variables</title>
1016
1017 <para>When specifying the <link linkend="texttext">text</link> attribute of the <link linkend="Text">Text</link> control or any tooltip attribute, you can insert escape sequences which will be expanded dynamically. An escape sequence always starts with the '$' character, followed by one or more predefined letters. Here is the list of accepted escape sequences:</para>
1018
1019 <itemizedlist>
1020   <listitem><para>
1021     <emphasis>$B</emphasis>: Get the audio stream bitrate (in kb/s).
1022   </para></listitem>
1023   <listitem><para>
1024     <emphasis>$V</emphasis>: Value of the volume (from 0 to 100 --> useful for a percentage).
1025   </para></listitem>
1026   <listitem><para>
1027     <emphasis>$T</emphasis>: Current time (the output format is H:MM:SS).
1028   </para></listitem>
1029   <listitem><para>
1030     <emphasis>$L</emphasis>: Remaining time, when available (the output format is H:MM:SS).
1031   </para></listitem>
1032   <listitem><para>
1033     <emphasis>$D</emphasis>: Duration of the stream, when available (the output format is H:MM:SS).
1034   </para></listitem>
1035   <listitem><para>
1036     <emphasis>$t, $l, $d</emphasis>: Same as $T, $L and $D, except that the hour in the format is displayed only if its value is different from 0. These text variables were needed to support Winamp2 skins, but it is advised to use the uppercase ones. (Since VLC 0.8.5).
1037   </para></listitem>
1038   <listitem><para>
1039     <emphasis>$H</emphasis>: Value of the <link linkend="help">help</link> attribute of the control that is under the mouse. The main use of this escape character is to create a kind of status bar, providing contextual help.</para>
1040     <note><para>Escape sequences in the help string are also transformed (except $H itself, it would generate an infinite loop!).</para></note>
1041   </listitem>
1042   <listitem><para>
1043     <emphasis>$N</emphasis>: Name of the stream that is being played.
1044   </para></listitem>
1045   <listitem><para>
1046     <emphasis>$F</emphasis>: Full name (with path) of the stream that is being played.
1047   </para></listitem>
1048   <listitem><para>
1049     <emphasis>$S</emphasis>: Get the audio sample rate (in kHz).
1050   </para></listitem>
1051 </itemizedlist>
1052
1053 <para>Example of <link linkend="slidertooltiptext">tooltiptext</link> value for a slider controlling the volume: "Volume: $V%".</para>
1054
1055 </sect1>
1056
1057 <sect1 id="boolexpr">
1058 <title>Boolean expressions</title>
1059
1060 <para>Some attributes in the XML file require a boolean value, such as "true" or "false". But sometimes, you may need something more complex than a mere "static" boolean value. For example, let's say that you want a <link linkend="Text">Text</link> control to display "Pause" whenever the stream is paused. Wouldn't it be nice to show this control only when the stream is paused, and to hide it the rest of the time? Well, guess what: this is possible. You only have to set the <link linkend="visible">visible</link> attribute of the <link linkend="Text">Text</link> control to "vlc.isPaused".</para>
1061
1062 <para>Here is a list of all the dynamic statuses that can be used in boolean expressions:</para>
1063
1064 <itemizedlist>
1065   <listitem><para>
1066     <emphasis>equalizer.isEnabled</emphasis>: True if the equalizer audio filter is enabled (since VLC 0.8.5).
1067   </para></listitem>
1068   <listitem><para>
1069     <emphasis>vlc.hasVout</emphasis>: True if a video is being played (since VLC 0.8.5).
1070   </para></listitem>
1071   <listitem><para>
1072     <emphasis>vlc.hasAudio</emphasis>: True if audio is being played (since VLC 0.8.5).
1073   </para></listitem>
1074   <listitem><para>
1075     <emphasis>vlc.isFullscreen</emphasis>: True when the video is in fullscreen mode (since VLC 0.8.5).
1076   </para></listitem>
1077   <listitem><para>
1078     <emphasis>vlc.isPlaying</emphasis>: True when VLC is playing, false otherwise.
1079   </para></listitem>
1080   <listitem><para>
1081     <emphasis>vlc.isStopped</emphasis>: True when VLC is stopped, false otherwise.
1082   </para></listitem>
1083   <listitem><para>
1084     <emphasis>vlc.isPaused</emphasis>: True when VLC is paused, false otherwise.
1085   </para></listitem>
1086   <listitem><para>
1087     <emphasis>vlc.isSeekable</emphasis>: True when the stream is seekable, false otherwise. This one can be used if you want to display a slider only when seeking is allowed.
1088   </para></listitem>
1089   <listitem><para>
1090     <emphasis>vlc.isMute</emphasis>: True when the sound is mute (in VLC, not on your OS), false otherwise.
1091   </para></listitem>
1092   <listitem><para>
1093     <emphasis>vlc.isOnTop</emphasis>: True when the windows have the "Always on top" status (since VLC 0.8.0).
1094   </para></listitem>
1095   <listitem><para>
1096     <emphasis>playlist.isRandom</emphasis>: True when the playlist items are played in a random order, false otherwise.
1097   </para></listitem>
1098   <listitem><para>
1099     <emphasis>playlist.isLoop</emphasis>: True when the playlist is looping, false otherwise.
1100   </para></listitem>
1101   <listitem><para>
1102     <emphasis>playlist.isRepeat</emphasis>: True when the current playlist item is being repeated, false otherwise (since VLC 0.8.0).
1103   </para></listitem>
1104   <listitem><para>
1105    <emphasis>dvd.isActive</emphasis>: True when a DVD is currently playing. This variable can be used to display buttons associated to the <link linkend="dvdactions">dvd.* actions</link> only when needed (since VLC 0.8.5).
1106   </para></listitem>
1107   <listitem><para>
1108     <emphasis>WindowID.isMaximized</emphasis>: True when the window whose <link linkend="windowid">id</link> is "WindowID" is maximized, false otherwise.
1109   </para></listitem>
1110   <listitem><para>
1111     <emphasis>WindowID.isVisible</emphasis>: True when the window whose <link linkend="windowid">id</link> is "WindowID" is visible, false otherwise.
1112   </para></listitem>
1113   <listitem><para>
1114     <emphasis>LayoutID.isVisible</emphasis>: True when the layout whose <link linkend="layoutid">id</link> is "LayoutID" is the active layout in its window (even if the window is hidden), false otherwise (since VLC 0.8.6).
1115   </para></listitem>
1116 </itemizedlist>
1117
1118 <para>In addition to these dynamic values, you can use the constant values "true" and "false". And of course, any combination is allowed, using the "and", "or" and "not" operators. For example, supposing that you have a window named "playlist_window", the following expression is valid (even though completely stupid):</para>
1119 <para>visible="(true) and ((not playlist_window.isVisible) and (not vlc.isStopped or false))"</para>
1120
1121 </sect1>
1122
1123 <sect1 id="percent">
1124 <title>Percentage variables</title>
1125
1126 <para>Every <link linkend="Slider">slider</link> is associated to a percentage variable, which corresponds to the position of the cursor (between 0 and 100%)</para>
1127
1128 <para>Here is a list of predefined percentage variables:</para>
1129
1130 <itemizedlist>
1131   <listitem><para>
1132     <emphasis>equalizer.band(n)</emphasis>: Where 'n' is an integer between 0 and 9. When the equalizer audio filter is enabled, this value corresponds to the amplification factor of the n'th frequency band: 0% means -20 dB, and 100% means +20 dB. The frequencies corresponding to the 10 bands are: 60Hz, 170Hz, 310Hz, 600Hz, 1kHz, 3kHz, 6kHz, 12kHz, 14kHz, 16kHz. (Since VLC 0.8.5)
1133   </para></listitem>
1134   <listitem><para>
1135     <emphasis>equalizer.preamp</emphasis>: Preamplification value (if the equalizer audio filter is enabled). A value of 0% means -20 dB, and 100% means +20 dB. (Since VLC 0.8.5)
1136   </para></listitem>
1137   <listitem><para>
1138     <emphasis>time</emphasis>: Position of the stream being played.
1139   </para></listitem>
1140   <listitem><para>
1141     <emphasis>volume</emphasis>: Value of the volume.
1142   </para></listitem>
1143 </itemizedlist>
1144
1145 </sect1>
1146
1147 <sect1 id="layoutmodel">
1148 <title>Layout model</title>
1149
1150 <para>Placing the controls on a window is easy, using their x and y attributes, but these positions become insufficient for a resizable window. Some controls (or groups of controls) should stay centered in the window, others should follow the right side of the window, others should change their size automatically, etc... To handle these various behaviours, the layout model followed by the skins engine is a model based on nested boxes.</para>
1151
1152 <para>There are 2 kinds of boxes:</para>
1153
1154 <itemizedlist>
1155   <listitem><para>
1156     <emphasis>simple boxes</emphasis>: These boxes cannot contain other boxes. All the visible controls are simple boxes: Image, Button, Checkbox, Text, Slider, RadialSlider, Playlist, Playtree, Video.
1157   </para></listitem>
1158   <listitem><para>
1159     <emphasis>container boxes</emphasis>: These boxes can contain other boxes. Only two XML tags create container boxes: <link linkend="Panel">Panel</link> and <link linkend="Layout">Layout</link>. The Layout tag is necessarily the top-level box for the current layout, and cannot be contained, but Panel elements can be contained.
1160   </para></listitem>
1161 </itemizedlist>
1162
1163 <para>A box inside a container box always defines how it should react when its container box is resized. Two different mechanisms are provided: corners anchoring (useful when resizing of the inner box is wanted, for example) and constant ratio (mainly useful to keep the inner box centered inside its parent):</para>
1164 <itemizedlist>
1165   <listitem><para>
1166     <emphasis>corners anchoring</emphasis>: The top-left-hand corner (TL) and the bottom-right-hand corner (BR) of the inner box are "tied" to corners of the container box (TL, TR, BL or BR). When any resizing occurs, tied corners move together, which can move or resize the inner box. For example, if the TL corner of the inner box is tied to the TL corner of the container (let's write it TL/TL), and if the BR corner of the inner box is also tied to the TL corner of the container box (BR/TL), the inner box will not be resized, and will always stay at the same place (this is the default behaviour). If we have TL/TL and TL/BL, the inner box is resized vertically its container is resized. If we have TL/TR and BR/TR, the inner box moves with the TR corner of its container. We could even define TL/BR and BR/TL, in which case increasing the size of the container box would shrink the size of the inner box... until it disappears completely!
1167   </para>
1168   <para>This mechanism is controlled by the <link linkend="lefttop">lefttop</link> and <link linkend="rightbottom">rightbottom</link> attributes of the controls.
1169   </para></listitem>
1170   <listitem><para>
1171     <emphasis>constant ratio</emphasis>: When a box doesn't fill completely its container box, there is space on the top, bottom, left and right of the inner box. It is possible to force the ratio between the space on the top and the space on the bottom (or the one on the left and the one on the right)  to be constant. Any resizing of the container box will then move the inner box accordingly, and the size of the inner box will never change (it overrides the corners anchoring mechanism). The horizontal and vertical ratios being independent, it is for example possible to keep only the horizontal ratio constant, in which case the inner box can still resize vertically (depending on its attributes for the corners anchoring, of course).
1172   </para>
1173   <para>This mechanism is controlled by the <link linkend="xkeepratio">xkeepratio</link> and <link linkend="ykeepratio">ykeepratio</link> attributes of the controls.
1174   </para></listitem>
1175 </itemizedlist>
1176
1177 </sect1>
1178
1179
1180 <sect1>
1181
1182 <title>Compression</title>
1183
1184 <para>When designing a new skin, it can be useful to organize your files in different directories. For example, you can have one directory for the fonts, another one for the images of the main window, yet another one for the images of the playlist window, etc...</para>
1185
1186 <para>But such a structure is not very convenient when it comes to distributing the skin. To address this problem, VLC is able to load skins directly from a .tar.gz archive containing all your files, along with directory information. When loading the skin, the files will be extracted in a temporary directory, then VLC will recursively search a file named "theme.xml", and the first one to be found will be used to load the skin. Of course, the temporary directory will be removed when you quit VLC or change the interface.</para>
1187
1188 <para>On Linux, creating a .tar.gz archive is rather straight-forward using the 'tar' and 'gzip' commands. On Windows, it can be done using Winzip, UltimateZip, or any other (well, almost) compression software...</para>
1189
1190 <para>Since VLC 0.8.5, it is also possible to archive your skin in a zip file.</para>
1191
1192 <para>It is advised to rename your .tar.gz (or .zip) archive with the .vlt extension, for 2 main reasons:</para>
1193
1194 <itemizedlist>
1195   <listitem><para>on some systems, the "Change skin" dialog box only displays files which have a .vlt or .xml extension,</para></listitem>
1196   <listitem><para>in the future, .vlt files could be associated to VLC in such a way that double-clicking a .vlt file would automatically load the skin in VLC.</para></listitem>
1197 </itemizedlist>
1198
1199 </sect1>
1200
1201 <sect1 id="bezier">
1202 <title>Bezier curves</title>
1203
1204 <para>One cool thing with VLC sliders is that they are not necessarily rectilinear, but they can follow any Bezier curve. So if you want to have a slider moving on a half-circle, or even doing a loop, you can!</para>
1205
1206 <para>This is not the place to explain how Bezier curves work (see <ulink url="http://astronomy.swin.edu.au/~pbourke/curves/bezier/">http://astronomy.swin.edu.au/~pbourke/curves/bezier/</ulink> for a nice introduction), the main thing to know is that a Bezier curve can be characterized by a set of points. Once you have them (thanks to the <link linkend="CurveMaker">CurveMaker</link> utility for example<!--XXX: deprecated-->), you just need to enter the list of points in the <link linkend="sliderpoints">points</link> attribute. Here is an example with 3 points: points="(2,50),(45,120),(88,50)".</para>
1207
1208 <para>Bezier curves can be used with the <link linkend="Slider">Slider</link> and <link linkend="Anchor">Anchor</link> tags:</para>
1209
1210 <itemizedlist>
1211     <listitem><para>For sliders, it defines the curve followed by the cursor of the slider. This curve is of course invisible, so if you want a visible background for your <link linkend="Slider">Slider</link> you need to provide it yourself using a <link linkend="SliderBackground">SliderBackground</link> or <link linkend="Image">Image</link> tag.</para></listitem>
1212   <listitem><para>For anchors, the use of Bezier curves is more anecdotic. Its purpose is to have non-ponctual anchor, the whole curve becoming the anchor. In this case, a ponctual anchor (and only a ponctual one) can be attracted by any point of the curve, if it is in its range of action. In fact, you can consider the curve as an easy way to define at once many anchors that share the same properties (except their position, of course :)).</para></listitem>
1213 </itemizedlist>
1214
1215 <note><para>The coordinates are relative to the upper-left corner of the control (i.e. to its <link linkend="x">x</link> and <link linkend="y">y</link> attributes).</para></note>
1216
1217 </sect1>
1218
1219 <sect1>
1220 <title>Tools and advice</title>
1221
1222   <sect2 id="CurveMaker">
1223   <title>Generating Bezier curves</title>
1224
1225   <para>
1226 To generate easily Bezier curves, you can use the <ulink url="/vlc/skins/VLC-curve-maker.exe">CurveMaker</ulink> utility (sorry, this is for Windows users only). Basically, you add and remove points at will, and you can move them to see how the curve evolves. When you have reached the perfect curve, you just have to copy-paste the list of abscissas and ordinates to form the <link linkend="sliderpoints">points</link> attribute of your <link linkend="Slider">Slider</link> or <link linkend="Anchor">Anchor</link>. The curve-maker also allows to load a .bmp file, this could be useful if you want to follow a specific pattern of a slider, for example.
1227   </para>
1228
1229 <note><para>This tool was made for the first version of the skins and has not been modified since then. This explains why it does not use PNG files and why it does not generate directly the value of the <link linkend="sliderpoints">points</link> attribute.</para></note>
1230   </sect2>
1231
1232   <sect2>
1233   <title>Using VLC warning messages</title>
1234   <para>
1235 VLC is able to give warnings and error messages about a loaded skin if it finds problems in the XML file. This can be very helpful to detect syntax errors (a tag which is never closed for example), or incorrect values of attributes. Here is how to see these messages:
1236   </para>
1237
1238 <itemizedlist>
1239   <listitem><para>on Linux, simply start VLC from a console with the following command-line: 'vlc -I skins2 -v' (you can use -vv if you want to see debug messages too),</para></listitem>
1240   <listitem><para>on Windows it is more difficult to use the same method (but you can use it with a rxvt console, in the Cygwin environment). Then another solution is to start VLC with a command-line such as 'vlc -I skins2 -v --extraintf logger'. This should open both VLC and a log window containing the messages. What's more, the logs should be saved in a file named 'vlc-log.txt', in VLC installation directory. The relevant lines are those starting with "[00000178] skins2 interface" (the number may be different).</para></listitem>
1241 </itemizedlist>
1242
1243   </sect2>
1244
1245   <sect2>
1246   <title>Relative paths</title>
1247
1248   <para>
1249 For the Bitmap tags, do not use absolute paths but relative paths (they are relative to the XML file directory), so that your skin can be reused by anybody without a particular file structure.
1250   </para>
1251   </sect2>
1252
1253   <sect2>
1254   <title>Get inspiration</title>
1255
1256   <para>
1257 In order to use plainly the possibilities given, you should look at how existing skins are made, it may give you ideas for your own skins...
1258   </para>
1259   </sect2>
1260
1261   <sect2>
1262   <title>Submit your skin!</title>
1263
1264   <para>
1265 Once your skin is finished, you can share it with other people. The easiest way is probably to send it by email to vlc -at- videolan -dot- org, so that we can put it on the website with the other ones.
1266   </para>
1267   </sect2>
1268
1269 </sect1>
1270
1271 </article>
1272