annotate DOCS/skin.html @ 8889:18427eee9205

The attached little patch fixes a core dump on termcap systems when $TERM is undefined. Frederick Bruckman <fredb@immanent.net>
author arpi
date Sat, 11 Jan 2003 12:32:24 +0000
parents 7b6b7fb76965
children 99a3ab65891d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
2 <html>
b190d3e9427c init version
pontscho
parents:
diff changeset
3 <head>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6882
f3f87f6bf5cf Added a uniform title: something - MPlayer - The Movie Player for Linux.
diego
parents: 6726
diff changeset
5 <title>Creating Skins - MPlayer - The Movie Player for Linux</title>
6395
9b218a01b74b use default.css
diego
parents: 6271
diff changeset
6 <link rel="stylesheet" type="text/css" href="default.css">
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
7 <style type="text/css">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
8 em.note {color: green;
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
9 font-style: normal;}
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
10 em.warn {color: red;
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
11 font-style: normal;}
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
12 </style>
b190d3e9427c init version
pontscho
parents:
diff changeset
13 </head>
b190d3e9427c init version
pontscho
parents:
diff changeset
14
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
15 <body>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
16
b190d3e9427c init version
pontscho
parents:
diff changeset
17 <h1 align="center">MPlayer skin format</h1>
b190d3e9427c init version
pontscho
parents:
diff changeset
18
b190d3e9427c init version
pontscho
parents:
diff changeset
19 <hr>
b190d3e9427c init version
pontscho
parents:
diff changeset
20
b190d3e9427c init version
pontscho
parents:
diff changeset
21 <h2>Contents</h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
22
b190d3e9427c init version
pontscho
parents:
diff changeset
23 <ul type=disc>
b190d3e9427c init version
pontscho
parents:
diff changeset
24 <li><a href="#intro">1 Introduction</a></li>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
25 <li><a href="#overview">2 Overview</a>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
26 <ul type=circle>
b190d3e9427c init version
pontscho
parents:
diff changeset
27 <li><a href="#dirs">2.1 Directories</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
28 <li><a href="#images">2.2 Images</a></li>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
29 <li><a href="#components">2.3 Skin components</a></li>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
30 <li><a href="#files">2.4 Files</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
31 </ul>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
32 </li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
33 <li><a href="#skin">3 The <code>skin</code> file</a>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
34 <ul type=circle>
b190d3e9427c init version
pontscho
parents:
diff changeset
35 <li><a href="#mainwin">3.1 Main window</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
36 <li><a href="#subwindow">3.2 Subwindow</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
37 <li><a href="#skinmenu">3.3 Skin menu</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
38 </ul>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
39 </li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
40 <li><a href="#fonts">4 Fonts</a>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
41 <ul type=circle>
b190d3e9427c init version
pontscho
parents:
diff changeset
42 <li><a href="#symbols">4.1 Symbols</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
43 </ul>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
44 </li>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
45 <li><a href="#guimsg">Appendix A: GUI messages</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
46 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
47
b190d3e9427c init version
pontscho
parents:
diff changeset
48 <hr>
b190d3e9427c init version
pontscho
parents:
diff changeset
49
b190d3e9427c init version
pontscho
parents:
diff changeset
50 <div align=center>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
51 Last modified: 2002/05/24
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
52 </div>
b190d3e9427c init version
pontscho
parents:
diff changeset
53
b190d3e9427c init version
pontscho
parents:
diff changeset
54 <hr>
b190d3e9427c init version
pontscho
parents:
diff changeset
55
b190d3e9427c init version
pontscho
parents:
diff changeset
56 <h2><a name="intro">1 Introduction</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
57
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
58 The purpose of this document is to describe the MPlayer skin format.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
59 The information contained here might be wrong, for
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
60
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
61 <ol type="a">
8432
7b6b7fb76965 small updates
diego
parents: 8316
diff changeset
62 <li>It is not me who wrote the GUI.</li>
7b6b7fb76965 small updates
diego
parents: 8316
diff changeset
63 <li>The GUI is not finished.</li>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
64 <li>I might be wrong.</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
65 </ol>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
66
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
67 So do not be surprised if something does not work as described here.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
68
b190d3e9427c init version
pontscho
parents:
diff changeset
69 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
70 Thanks to <em>Zoltán Ponekker</em> for his help.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
71 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
72
b190d3e9427c init version
pontscho
parents:
diff changeset
73 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
74 <em>András Mohari &lt;mayday@freemail.hu&gt;</em>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
75 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
76
b190d3e9427c init version
pontscho
parents:
diff changeset
77
b190d3e9427c init version
pontscho
parents:
diff changeset
78 <h2><a name="overview">2 Overview</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
79
b190d3e9427c init version
pontscho
parents:
diff changeset
80 It does not really have anything to do with the skin format, but you should
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
81 know that MPlayer has <b>no</b> builtin skin, so <b>at least one skin
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
82 must be installed in order to be able to use the GUI.</b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
83
b190d3e9427c init version
pontscho
parents:
diff changeset
84
b190d3e9427c init version
pontscho
parents:
diff changeset
85 <h3><a name="dirs">2.1 Directories</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
86
b190d3e9427c init version
pontscho
parents:
diff changeset
87 The directories searched for skins are (in order):
b190d3e9427c init version
pontscho
parents:
diff changeset
88 <pre>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
89 $(DATADIR)/Skin/
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
90 $(PREFIX)/share/mplayer/Skin/
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
91 ~/.mplayer/Skin/
b190d3e9427c init version
pontscho
parents:
diff changeset
92 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
93
b190d3e9427c init version
pontscho
parents:
diff changeset
94 <p>
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
95 Note that the first path may vary according to the way MPlayer was
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
96 configured (see the <code>--prefix</code> and <code>--datadir</code> arguments
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
97 of the <code>configure</code> script).
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
98 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
99
b190d3e9427c init version
pontscho
parents:
diff changeset
100 Every skin is installed into its own directory under one of the directories
b190d3e9427c init version
pontscho
parents:
diff changeset
101 listed above, for example:
b190d3e9427c init version
pontscho
parents:
diff changeset
102 <pre>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
103 $(PREFIX)/share/mplayer/Skin/default/
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
104 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
105
b190d3e9427c init version
pontscho
parents:
diff changeset
106
b190d3e9427c init version
pontscho
parents:
diff changeset
107 <h3><a name="images">2.2 Image formats</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
108
8432
7b6b7fb76965 small updates
diego
parents: 8316
diff changeset
109 Images must be truecolor (24 or 32 bpp) PNGs.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
110
b190d3e9427c init version
pontscho
parents:
diff changeset
111 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
112 In the main window (see below) you can use images with `transparency':
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
113 Regions filled with the color #FF00FF (<font color="#FF00FF">magenta</font>)
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
114 are fully transparent when viewed by MPlayer. This means that you can even
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
115 have shaped windows if your X server has the XShape extension.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
116 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
117
b190d3e9427c init version
pontscho
parents:
diff changeset
118
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
119 <h3><a name="components">2.3 Skin components</a></h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
120
b190d3e9427c init version
pontscho
parents:
diff changeset
121 Skins are quite free-format (unlike the fixed-format skins of
b190d3e9427c init version
pontscho
parents:
diff changeset
122 Winamp/XMMS, for example), so it is up to you to create something great.
b190d3e9427c init version
pontscho
parents:
diff changeset
123
b190d3e9427c init version
pontscho
parents:
diff changeset
124 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
125 Currently there are three windows to be decorated: the
b190d3e9427c init version
pontscho
parents:
diff changeset
126 <a href="#mainwin">main window</a>, the <a href="#subwindow">subwindow</a> and
b190d3e9427c init version
pontscho
parents:
diff changeset
127 the <a href="#skinmenu">skin menu</a> (which can be activated by a right
b190d3e9427c init version
pontscho
parents:
diff changeset
128 click).
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
129 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
130
b190d3e9427c init version
pontscho
parents:
diff changeset
131 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
132 <li>
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
133 The <b>main window</b> is where you can control MPlayer. The background of
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
134 the window is an image. Various items can (and must) be
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
135 placed in the window: <em>buttons</em>, <em>potmeters</em> (sliders) and
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
136 <em>labels</em>. For every item, you must
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
137 specify its position and size.
b190d3e9427c init version
pontscho
parents:
diff changeset
138
b190d3e9427c init version
pontscho
parents:
diff changeset
139 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
140 A <b>button</b> has three states (pressed, released,
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
141 disabled), thus its image must be divided into three parts vertically.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
142 See the <a href="#main.button">button</a> item for details.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
143 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
144
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
145 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
146 A <b>potmeter</b> (mainly used for the seek bar and volume/balance
b190d3e9427c init version
pontscho
parents:
diff changeset
147 control) can have any number of phases by dividing its image into different
b190d3e9427c init version
pontscho
parents:
diff changeset
148 parts below each other.
b190d3e9427c init version
pontscho
parents:
diff changeset
149 See <a href="#main.hpotmeter">hpotmeter</a> and
b190d3e9427c init version
pontscho
parents:
diff changeset
150 <a href="#main.potmeter">potmeter</a> for details.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
151 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
152
b190d3e9427c init version
pontscho
parents:
diff changeset
153 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
154 <b>Labels</b> are a bit special: The characters needed to draw them are taken
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
155 from an image file, and the characters in the image are described
b190d3e9427c init version
pontscho
parents:
diff changeset
156 by a <a href="#fonts">font description file</a>.
b190d3e9427c init version
pontscho
parents:
diff changeset
157 The latter is a plain text file which specifies
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
158 the x,y position and size of each character in the image (the
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
159 image file and its font description file form a font <em>together</em>).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
160 See <a href="#main.dlabel">dlabel</a> and <a href="#main.slabel">slabel</a>
b190d3e9427c init version
pontscho
parents:
diff changeset
161 for details.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
162 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
163
b190d3e9427c init version
pontscho
parents:
diff changeset
164 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
165 <em class=note>
b190d3e9427c init version
pontscho
parents:
diff changeset
166 <b>Note:</b> all images can have full transparency as described in the
8316
gabucino
parents: 7814
diff changeset
167 section about <a href="#images">image formats</a>. If the X Server doesn't
gabucino
parents: 7814
diff changeset
168 support the XShape extension, the parts marked transparent will be black. If
gabucino
parents: 7814
diff changeset
169 you'd like to use this feature, the width of the main window's background image
gabucino
parents: 7814
diff changeset
170 must be dividable by 8.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
171 </em>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
172 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
173 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
174
b190d3e9427c init version
pontscho
parents:
diff changeset
175 <li>
b190d3e9427c init version
pontscho
parents:
diff changeset
176 The <b>subwindow</b> is where the movie appears. It can display a specified
b190d3e9427c init version
pontscho
parents:
diff changeset
177 image if there is no movie loaded (it is quite boring to have an empty
b190d3e9427c init version
pontscho
parents:
diff changeset
178 window :-))
b190d3e9427c init version
pontscho
parents:
diff changeset
179 <em class=note><b>Note:</b> transparency
b190d3e9427c init version
pontscho
parents:
diff changeset
180 is <b>not allowed</b> here.</em>
b190d3e9427c init version
pontscho
parents:
diff changeset
181 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
182
b190d3e9427c init version
pontscho
parents:
diff changeset
183 <li>
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
184 The <b>skin menu</b> is just a way to control MPlayer by means of
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
185 menu entries. Two images are required for the menu: one of them is the base
b190d3e9427c init version
pontscho
parents:
diff changeset
186 image that shows the menu in its normal state, the other one is used to
b190d3e9427c init version
pontscho
parents:
diff changeset
187 display the selected entries. When you pop up the menu, the first image is
b190d3e9427c init version
pontscho
parents:
diff changeset
188 shown. If you move the mouse over the menu entries, the currently selected
b190d3e9427c init version
pontscho
parents:
diff changeset
189 entry is copied from the second image over the menu entry below the mouse
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
190 pointer (the second image is never shown as a whole).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
191 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
192 A menu entry is defined by its position and size in the image (see the
b190d3e9427c init version
pontscho
parents:
diff changeset
193 section about the <a href="#skinmenu">skin menu</a> for details).
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
194 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
195 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
196 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
197
b190d3e9427c init version
pontscho
parents:
diff changeset
198 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
199 There is an important thing not mentioned yet: For buttons, potmeters and
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
200 menu entries to work, MPlayer must know what to do if they are clicked.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
201 This is done by <a href="#guimsg">messages</a> (events). For these items
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
202 you must define the messages to be generated when they are clicked.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
203 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
204
b190d3e9427c init version
pontscho
parents:
diff changeset
205 <h3><a name="files">2.4 Files</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
206
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
207 You need the following files to build a skin:
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
208 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
209 <li>
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
210 The configuration file named <a href="#skin">skin</a> tells MPlayer how
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
211 to put different parts of the skin together and what to do if you click
b190d3e9427c init version
pontscho
parents:
diff changeset
212 somewhere in the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
213 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
214 <li>The background image for the main window.</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
215 <li>Images for the items in the main window (including one or more font
b190d3e9427c init version
pontscho
parents:
diff changeset
216 description files needed to draw labels).</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
217 <li>The image to be displayed in the subwindow (optional).</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
218 <li>Two images for the skin menu (they are needed only if you want to create
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
219 a menu).</li>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
220 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
221
b190d3e9427c init version
pontscho
parents:
diff changeset
222 With the exception of the skin configuration file, you can name the other
b190d3e9427c init version
pontscho
parents:
diff changeset
223 files whatever you want (but note that font description files must have
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
224 a <code>.fnt</code> extension).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
225
b190d3e9427c init version
pontscho
parents:
diff changeset
226
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
227 <h2><a name="skin">3 The <code>skin</code> file</a></h2>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
228
b190d3e9427c init version
pontscho
parents:
diff changeset
229 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
230 As mentioned above, this is the skin configuration file.
b190d3e9427c init version
pontscho
parents:
diff changeset
231 It is line oriented; comment lines start with a '<code>;</code>' character
b190d3e9427c init version
pontscho
parents:
diff changeset
232 at the beginning of the line (only spaces and tabs are allowed before the
b190d3e9427c init version
pontscho
parents:
diff changeset
233 '<code>;</code>').
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
234 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
235
b190d3e9427c init version
pontscho
parents:
diff changeset
236 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
237 The file is made up of sections. Each section describes the skin for an
b190d3e9427c init version
pontscho
parents:
diff changeset
238 application and has the following form:
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
239 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
240
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
241 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
242 section = <i>section name</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
243 .
b190d3e9427c init version
pontscho
parents:
diff changeset
244 .
b190d3e9427c init version
pontscho
parents:
diff changeset
245 .
b190d3e9427c init version
pontscho
parents:
diff changeset
246 end
b190d3e9427c init version
pontscho
parents:
diff changeset
247 </pre></td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
248
b190d3e9427c init version
pontscho
parents:
diff changeset
249 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
250 Currently there is only one application, so you need only one section:
b190d3e9427c init version
pontscho
parents:
diff changeset
251 its name is <b>movieplayer</b>.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
252 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
253
b190d3e9427c init version
pontscho
parents:
diff changeset
254 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
255 Within this section each window is described by a block of the following form:
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
256 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
257
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
258 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
259 window = <i>window name</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
260 .
b190d3e9427c init version
pontscho
parents:
diff changeset
261 .
b190d3e9427c init version
pontscho
parents:
diff changeset
262 .
b190d3e9427c init version
pontscho
parents:
diff changeset
263 end
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
264 </pre></td></tr></table>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
265
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
266 <p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
267 where <i>window name</i> can be one of these strings:
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
268 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
269
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
270 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
271 <li><b>main</b> - for the main window</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
272 <li><b>sub</b> - for the subwindow</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
273 <li><b>menu</b> - for the skin menu</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
274 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
275
b190d3e9427c init version
pontscho
parents:
diff changeset
276 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
277 (The sub and menu blocks are optional - you do not need to create a menu or
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
278 decorate the subwindow.)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
279 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
280
b190d3e9427c init version
pontscho
parents:
diff changeset
281 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
282 Within a window block, you can define each item for the window
b190d3e9427c init version
pontscho
parents:
diff changeset
283 by a line in this form:
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
284 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
285
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
286 <dl>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
287 <dt>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
288 <b><code>item = parameter</code></b>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
289 </dt>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
290 <dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
291 Where <code>item</code> is a string that identifies the type of the GUI item,
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
292 <code>parameter</code> is a numeric or textual value (or a list of values
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
293 separated by commas).
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
294 </dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
295 </dl>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
296
b190d3e9427c init version
pontscho
parents:
diff changeset
297 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
298 Putting the above together, the whole file looks something like this:
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
299 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
300
b190d3e9427c init version
pontscho
parents:
diff changeset
301 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
302 section = movieplayer
b190d3e9427c init version
pontscho
parents:
diff changeset
303 window = main
b190d3e9427c init version
pontscho
parents:
diff changeset
304 ; ... items for main window ...
b190d3e9427c init version
pontscho
parents:
diff changeset
305 end
b190d3e9427c init version
pontscho
parents:
diff changeset
306
b190d3e9427c init version
pontscho
parents:
diff changeset
307 window = sub
b190d3e9427c init version
pontscho
parents:
diff changeset
308 ; ... items for subwindow ...
b190d3e9427c init version
pontscho
parents:
diff changeset
309 end
b190d3e9427c init version
pontscho
parents:
diff changeset
310
b190d3e9427c init version
pontscho
parents:
diff changeset
311 window = menu
8316
gabucino
parents: 7814
diff changeset
312 ; ... items for menu ...
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
313 end
b190d3e9427c init version
pontscho
parents:
diff changeset
314 end
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
315 </pre></td></tr></table>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
316
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
317 <p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
318 The name of an image file must be given without leading directories - images are
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
319 searched for in the <code>Skin</code> directory. You may (but you need not)
7814
988498df1996 <B>MPlayer</B> ---> MPlayer
diego
parents: 6882
diff changeset
320 specify the extension of the file. If the file does not exist, MPlayer
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
321 tries to load the file <code>&lt;filename&gt;.&lt;ext&gt;</code>, where
8316
gabucino
parents: 7814
diff changeset
322 <code>png</code> and <code>PNG</code> are tried for <code>&lt;ext&gt;</code>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
323 (in this order). The first matching file will be used.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
324 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
325
b190d3e9427c init version
pontscho
parents:
diff changeset
326 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
327 Finally some words about positioning. The main window and the subwindow can be
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
328 placed in the different corners of the screen by giving <code>X</code> and
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
329 <code>Y</code> coordinates. <code>0</code> is top or left, <code>-1</code> is
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
330 center and <code>-2</code> is right or bottom, as shown in this illustration:
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
331 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
332
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
333 <pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
334
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
335 (0, 0)----(-1, 0)----(-2, 0)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
336 | | |
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
337 | | |
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
338 (0,-1)----(-1,-1)----(-2,-1)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
339 | | |
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
340 | | |
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
341 (0,-2)----(-1,-2)----(-2,-2)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
342
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
343 </pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
344
b190d3e9427c init version
pontscho
parents:
diff changeset
345 <table border=1 cellpadding=5 width="100%"><tr bgcolor="#ffffcc"><td>
b190d3e9427c init version
pontscho
parents:
diff changeset
346 Here is an example to make this clear. Suppose that you have an image called
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
347 <code>main.png</code> that you use for the main window:
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
348 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
349 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
350 base = main, -1, -1
b190d3e9427c init version
pontscho
parents:
diff changeset
351 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
352 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
353
8316
gabucino
parents: 7814
diff changeset
354 MPlayer tries to load <code>main</code>, <code>main.png</code>,
gabucino
parents: 7814
diff changeset
355 <code>main.PNG</code> files.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
356 <br>
b190d3e9427c init version
pontscho
parents:
diff changeset
357 </td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
358
b190d3e9427c init version
pontscho
parents:
diff changeset
359
b190d3e9427c init version
pontscho
parents:
diff changeset
360 <h3><a name="mainwin">3.1 Main window</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
361
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
362 Below is the list of entries that can be used in the
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
363 '<code>window = main</code>' .&nbsp;.&nbsp;. '<code>end</code>' block.
b190d3e9427c init version
pontscho
parents:
diff changeset
364
b190d3e9427c init version
pontscho
parents:
diff changeset
365 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
366 <dt><a name="main.base">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
367 <b><code>base = image, X, Y</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
368 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
369 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
370 Lets you specify the background image to be used for the main window.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
371 The window will appear at the given <code>X,Y</code> position on the screen
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
372 The window will have the size of the image.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
373 <div>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
374 <em class=warn>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
375 <b>Warning:</b> Transparent regions in the image (colored #FF00FF) appear
8316
gabucino
parents: 7814
diff changeset
376 black on X servers without the XShape extension. The image's width must be
gabucino
parents: 7814
diff changeset
377 dividable by 8.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
378 </em>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
379 </div>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
380 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
381
b190d3e9427c init version
pontscho
parents:
diff changeset
382 <dt><a name="main.button">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
383 <b><code>button = image, X, Y, width, height, message</code></b></a></dt>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
384 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
385 Place a button of <code>width</code> * <code>height</code> size at position
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
386 <code>X</code>,<code>Y</code>. The specified <code>message</code> is generated
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
387 when the button is clicked. The image given by <code>image</code> must have
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
388 three parts below each other (according to the possible states of the button),
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
389 like this:
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
390 <pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
391 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
392 | pressed |
b190d3e9427c init version
pontscho
parents:
diff changeset
393 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
394 | released |
b190d3e9427c init version
pontscho
parents:
diff changeset
395 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
396 | disabled |
b190d3e9427c init version
pontscho
parents:
diff changeset
397 +------------+
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
398 </pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
399 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
400
b190d3e9427c init version
pontscho
parents:
diff changeset
401 <dt><a name="main.decoration">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
402 <b><code>decoration = enable|disable</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
403 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
404 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
405 Enable or disable window manager decoration of the main window. Default
b190d3e9427c init version
pontscho
parents:
diff changeset
406 is <b>disable</b>.
b190d3e9427c init version
pontscho
parents:
diff changeset
407 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
408
b190d3e9427c init version
pontscho
parents:
diff changeset
409 <dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
410 <a name="main.hpotmeter">
b190d3e9427c init version
pontscho
parents:
diff changeset
411 <b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
412 <code>hpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message</code>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
413 </b>
b190d3e9427c init version
pontscho
parents:
diff changeset
414 </a>
b190d3e9427c init version
pontscho
parents:
diff changeset
415 </dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
416 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
417 Place a horizontal potmeter of <code>width</code> * <code>height</code> size
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
418 at position <code>X</code>,<code>Y</code>. The image can be divided into
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
419 different parts for the different phases of the potmeter (for example,
b190d3e9427c init version
pontscho
parents:
diff changeset
420 you can have a pot for volume control that turns from green to red
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
421 while its value changes from the minimum to the maximum.).
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
422 <code>hpotmeter</code> can have a button that can be dragged horizontally.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
423
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
424 <div>The parameters are:</div>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
425
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
426 <ul>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
427 <li><code>button</code> - the image to be used for the button
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
428 (must have three parts below each other, like in case of
b190d3e9427c init version
pontscho
parents:
diff changeset
429 <a href="#main.button">button</a>)</li>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
430 <li><code>bwidth</code>, <code>bheight</code> - size of the button</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
431 <li><code>phases</code> - The image to be used for the different phases of the
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
432 hpotmeter. A special value of <code>NULL</code> can be used if you want
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
433 no such image. The image must be divided into <code>numphases</code> parts
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
434 vertically like this:
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
435 <pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
436 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
437 | phase #1 |
b190d3e9427c init version
pontscho
parents:
diff changeset
438 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
439 | phase #2 |
b190d3e9427c init version
pontscho
parents:
diff changeset
440 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
441 ...
b190d3e9427c init version
pontscho
parents:
diff changeset
442 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
443 | phase #n |
b190d3e9427c init version
pontscho
parents:
diff changeset
444 +------------+
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
445 </pre>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
446 </li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
447 <li><code>numphases</code> - number of phases stored in the <code>phases</code>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
448 image</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
449 <li><code>default</code> - default value for hpotmeter (in the range 0 to
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
450 100)</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
451 <li><code>X</code>, <code>Y</code> - position for the hpotmeter</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
452 <li><code>width</code>, <code>height</code> - width and height of the
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
453 <code>hpotmeter</code></li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
454 <li><code>message</code> - the message to be generated when the value of
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
455 <code>hpotmeter</code> is changed</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
456 </ul>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
457
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
458 <em class=note>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
459 <b>Note:</b> There will be a <code>vpotmeter</code> item, too, but it is not
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
460 implemented yet.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
461 </em>
b190d3e9427c init version
pontscho
parents:
diff changeset
462 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
463
b190d3e9427c init version
pontscho
parents:
diff changeset
464 <dt><a name="main.potmeter">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
465 <b><code>potmeter = phases, numphases, default, X, Y, width, height, message</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
466 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
467 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
468 A <code>hpotmeter</code> without a button. (I guess it is meant to be turned
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
469 around, but it reacts to horizontal dragging only.)
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
470 For the description of the parameters see
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
471 <a href="#main.hpotmeter">hpotmeter</a>. <code>phases</code> can be
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
472 <code>NULL</code>, but it is quite useless, since you cannot see where
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
473 the <code>potmeter</code> is set.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
474 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
475
b190d3e9427c init version
pontscho
parents:
diff changeset
476 <dt><a name="main.font">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
477 <b><code>font = fontfile, fontid</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
478 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
479 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
480 Defines a font. <code>fontfile</code> is the name of a font description file
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
481 with a <code>.fnt</code> extension (<b>do not</b> specify the extension here).
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
482 <code>fontid</code> is used to refer to the font
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
483 (see <a href="#main.dlabel">dlabel</a> and <a href="#main.slabel">slabel</a>).
b190d3e9427c init version
pontscho
parents:
diff changeset
484 Up to 25 fonts can be defined.
b190d3e9427c init version
pontscho
parents:
diff changeset
485 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
486
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
487 <dt><a name="main.slabel">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
488 <b><code>slabel = X, Y, fontid, "text"</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
489 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
490 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
491 Place a static label at the position <code>X</code>,<code>Y</code>.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
492 <code>text</code> is displayed using the font identified by <code>fontid</code>.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
493 The text is just a raw string (<code>$x</code> variables do not work) that must
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
494 be enclosed between double quotes (but the <code>"</code> character cannot be
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
495 part of the text). The label is displayed using the font identified by
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
496 <code>fontid</code>.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
497 </dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
498
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
499 <dt><a name="main.dlabel">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
500 <b><code>dlabel = X, Y, length, align, fontid, "text"</code></b>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
501 </a></dt>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
502 <dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
503 Place a dynamic label at the position <code>X</code>,<code>Y</code>. The label is
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
504 called dynamic because its text is refreshed periodically. The maximum length of
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
505 the label is given by <code>length</code> (its height is the height of a
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
506 character). If the text to be displayed is wider than that, it will be scrolled,
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
507 otherwise it is aligned within the specified space by the value of the
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
508 <code>align</code> parameter: <code>0</code> is for right, <code>1</code> is for
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
509 center, <code>2</code> is for left.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
510 <br>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
511 The text to be displayed is given by <code>text</code>: It must be written
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
512 between double quotes (but the <code>"</code> character cannot be part of the
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
513 text). The label is displayed using the font identified by <code>fontid</code>.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
514 You can use the following variables in the text:
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
515
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
516 <table align="center" border="1">
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
517 <tr align=center><th>Variable</th><th align=left>Meaning</th></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
518 <tr><td align=center><kbd>$1</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
519 <td>play time in <em>hh:mm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
520 <tr><td align=center><kbd>$2</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
521 <td>play time in <em>mmmm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
522 <tr><td align=center><kbd>$3</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
523 <td>play time in <em>hh</em> format (hours)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
524 <tr><td align=center><kbd>$4</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
525 <td>play time in <em>mm</em> format (minutes)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
526 <tr><td align=center><kbd>$5</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
527 <td>play time in <em>ss</em> format (seconds)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
528 <tr><td align=center><kbd>$6</kbd></td>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
529 <td>movie length in <em>hh:mm:ss</em> format</td></tr>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
530 <tr><td align=center><kbd>$7</kbd></td>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
531 <td>movie length in <em>mmmm:ss</em> format</td></tr>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
532 <tr><td align=center><kbd>$8</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
533 <td>play time in <em>h:mm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
534 <tr><td align=center><kbd>$v</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
535 <td>volume in <em>xxx.xx%</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
536 <tr><td align=center><kbd>$V</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
537 <td>volume in <em>xxx.x</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
538 <tr><td align=center><kbd>$b</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
539 <td>balance in <em>xxx.xx%</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
540 <tr><td align=center><kbd>$B</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
541 <td>balance in <em>xxx.x</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
542 <tr><td align=center><kbd>$$</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
543 <td>the <kbd>$</kbd> character</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
544 <tr><td align=center><kbd>$a</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
545 <td>a character according to the audio type (none: <code>n</code>,
b190d3e9427c init version
pontscho
parents:
diff changeset
546 mono: <code>m</code>, stereo: <code>t</code>)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
547 <tr><td align=center><kbd>$t</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
548 <td>track number (in playlist)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
549 <tr><td align=center><kbd>$o</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
550 <td>filename</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
551 <tr><td align=center><kbd>$f</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
552 <td>filename in lower case</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
553 <tr><td align=center><kbd>$F</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
554 <td>filename in upper case</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
555 <tr><td align=center><kbd>$T</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
556 <td>a character according to the stream type (file: <code>f</code>,
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
557 Video CD: <code>v</code>, DVD: <code>d</code>, URL: <code>u</code>)
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
558 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
559 <tr><td align=center><kbd>$p</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
560 <td>the "p" character (if a movie is playing and the font has the "p"
b190d3e9427c init version
pontscho
parents:
diff changeset
561 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
562 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
563 <tr><td align=center><kbd>$s</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
564 <td>the "s" character (if the movie is stopped and the font has the "s"
b190d3e9427c init version
pontscho
parents:
diff changeset
565 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
566 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
567 <tr><td align=center><kbd>$e</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
568 <td>the "e" character (if playback is paused and the font has the "e"
b190d3e9427c init version
pontscho
parents:
diff changeset
569 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
570 </td></tr>
8316
gabucino
parents: 7814
diff changeset
571 <tr><td align=center><kbd>$x</kbd></td>
gabucino
parents: 7814
diff changeset
572 <td>movie width
gabucino
parents: 7814
diff changeset
573 </td></tr>
gabucino
parents: 7814
diff changeset
574 <tr><td align=center><kbd>$y</kbd></td>
gabucino
parents: 7814
diff changeset
575 <td>movie height
gabucino
parents: 7814
diff changeset
576 </td></tr>
gabucino
parents: 7814
diff changeset
577 <tr><td align=center><kbd>$C</kbd></td>
8432
7b6b7fb76965 small updates
diego
parents: 8316
diff changeset
578 <td>name of the codec used
8316
gabucino
parents: 7814
diff changeset
579 </td></tr>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
580 </table>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
581
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
582 <em class="note">
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
583 <b>Note:</b> The <kbd>$a</kbd>, <kbd>$T</kbd>, <kbd>$p</kbd>, <kbd>$s</kbd>
b190d3e9427c init version
pontscho
parents:
diff changeset
584 and <kbd>$e</kbd> variables all return characters that should be displayed
b190d3e9427c init version
pontscho
parents:
diff changeset
585 as special symbols (for example, "e" is for the pause symbol that usually
b190d3e9427c init version
pontscho
parents:
diff changeset
586 looks something like <code>||</code>). You should have a font for normal
b190d3e9427c init version
pontscho
parents:
diff changeset
587 characters and a different font for symbols.
b190d3e9427c init version
pontscho
parents:
diff changeset
588 See the section about <a href="#symbols">symbols</a> for more information.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
589 </em>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
590 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
591 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
592
b190d3e9427c init version
pontscho
parents:
diff changeset
593
b190d3e9427c init version
pontscho
parents:
diff changeset
594 <h3><a name="subwindow">3.2 Subwindow</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
595
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
596 The following entries can be used in the
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
597 '<code>window = sub</code>' .&nbsp;.&nbsp;. '<code>end</code>' block.
b190d3e9427c init version
pontscho
parents:
diff changeset
598
b190d3e9427c init version
pontscho
parents:
diff changeset
599 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
600 <dt><a name="sub.base">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
601 <b><code>base = image, X, Y, width, height</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
602 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
603 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
604 The image to be displayed in the window.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
605 The window will appear at the given <code>X</code>,<code>Y</code> position
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
606 on the screen (<code>0,0</code> is the top left corner). You can specify
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
607 <code>-1</code> for center and <code>-2</code> for right (<code>X</code>) and
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
608 bottom (<code>Y</code>). The window will be as large as the image.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
609 <code>width</code> and <code>height</code> denote the size of the window; they
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
610 are optional (if they are missing, the window is the same size as the image).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
611 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
612
b190d3e9427c init version
pontscho
parents:
diff changeset
613 <dt><a name="sub.background">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
614 <b><code>background = R, G, B</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
615 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
616 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
617 Lets you set the background color. It is useful if the image is smaller than
b190d3e9427c init version
pontscho
parents:
diff changeset
618 the window.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
619 <code>R</code>, <code>G</code> and <code>B</code> specifies the red, green and blue
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
620 component of the color (each of them is a decimal number from 0 to 255).
b190d3e9427c init version
pontscho
parents:
diff changeset
621 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
622 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
623
b190d3e9427c init version
pontscho
parents:
diff changeset
624
b190d3e9427c init version
pontscho
parents:
diff changeset
625 <h3><a name="skinmenu">3.3 Skin menu</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
626
b190d3e9427c init version
pontscho
parents:
diff changeset
627 As mentioned earlier, the menu is displayed using two images.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
628 Normal menu entries are taken from the image specified by the <code>base</code>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
629 item, while the currently selected entry is taken from the image specified
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
630 by the <code>selected</code> item. You must define the position and size of each
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
631 menu entry through the <code>menu</code> item.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
632
b190d3e9427c init version
pontscho
parents:
diff changeset
633 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
634 These are the entries that can be used in the '<code>window = menu</code>'
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
635 .&nbsp;.&nbsp;. '<code>end</code>' block.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
636 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
637
b190d3e9427c init version
pontscho
parents:
diff changeset
638 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
639 <dt><a name="menu.base">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
640 <b><code>base = image</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
641 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
642 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
643 The image for normal menu entries.
b190d3e9427c init version
pontscho
parents:
diff changeset
644 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
645
b190d3e9427c init version
pontscho
parents:
diff changeset
646 <dt><a name="menu.selected">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
647 <b><code>selected = image</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
648 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
649 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
650 The image showing the menu with all entries selected.
b190d3e9427c init version
pontscho
parents:
diff changeset
651 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
652
b190d3e9427c init version
pontscho
parents:
diff changeset
653 <dt><a name="menu.menu">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
654 <b><code>menu = X, Y, width, height, message</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
655 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
656 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
657 Defines the <code>X,Y</code> position and the size of a menu entry in
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
658 the image. <code>message</code> is the message to be generated when
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
659 the mouse button is released over the entry.
b190d3e9427c init version
pontscho
parents:
diff changeset
660 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
661 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
662
b190d3e9427c init version
pontscho
parents:
diff changeset
663
b190d3e9427c init version
pontscho
parents:
diff changeset
664 <h2><a name="fonts">4 Fonts</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
665
b190d3e9427c init version
pontscho
parents:
diff changeset
666 As mentioned in the section about the parts of a skin, a font is defined
b190d3e9427c init version
pontscho
parents:
diff changeset
667 by an image and a description
b190d3e9427c init version
pontscho
parents:
diff changeset
668 file. You can place the characters anywhere in the image, but make sure that
b190d3e9427c init version
pontscho
parents:
diff changeset
669 their position and size is given in the description file exactly.
b190d3e9427c init version
pontscho
parents:
diff changeset
670
b190d3e9427c init version
pontscho
parents:
diff changeset
671 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
672 The font description file (with <code>.fnt</code> extension) can have comment
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
673 lines starting with '<code>;</code>'. The file must have a line in the form
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
674 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
675
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
676 <dl>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
677 <dt><a name="font.image">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
678 <b><code>image = image</code></b>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
679 </a></dt>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
680 <dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
681 Where <code>image</code> is the name of the image file to be used for
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
682 the font (you do not have to specify the extension).
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
683 </dd>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
684
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
685 <dt><a name="font.char">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
686 <b><code>"char" = X, Y, width, height</code></b>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
687 </a></dt>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
688 <dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
689 Here <code>X</code> and <code>Y</code> specify the position of the
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
690 <code>char</code> character in the image (<code>0,0</code> is the upper left
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
691 corner). <code>width</code> and <code>height</code> are the dimensions of the
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
692 character in pixels.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
693 </dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
694 </dl>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
695
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
696 This example defines the A, B, C characters using <code>font.png</code>.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
697 <table width="100%" border=1><tr bgcolor=silver><td><pre>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
698 ; Can be "font" instead of "font.png".
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
699 image = font.png
b190d3e9427c init version
pontscho
parents:
diff changeset
700
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
701 ; Three characters are enough for demonstration purposes :-)
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
702 "A" = 0,0, 7,13
b190d3e9427c init version
pontscho
parents:
diff changeset
703 "B" = 7,0, 7,13
b190d3e9427c init version
pontscho
parents:
diff changeset
704 "C" = 14,0, 7,13
b190d3e9427c init version
pontscho
parents:
diff changeset
705 </pre></td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
706
b190d3e9427c init version
pontscho
parents:
diff changeset
707
b190d3e9427c init version
pontscho
parents:
diff changeset
708 <h3><a name="symbols">4.1 Symbols</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
709
b190d3e9427c init version
pontscho
parents:
diff changeset
710 Some characters have special meanings when returned by some of the variables
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
711 used in <a href="#main.dlabel">dlabel</a>. These characters are meant to be
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
712 shown as symbols so that things like a nice DVD logo can be displayed instead
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
713 of the character 'd' for a DVD stream.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
714
b190d3e9427c init version
pontscho
parents:
diff changeset
715 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
716 The following table lists all the characters that can be used to display
b190d3e9427c init version
pontscho
parents:
diff changeset
717 symbols (and thus require a different font).
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
718 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
719
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
720 <table align="center" border="1">
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
721 <tr><th align=center>Character</th><th align=left>Symbol</th></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
722 <tr><td align=center><kbd>p</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
723 <td align=left>play</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
724 <tr><td align=center><kbd>s</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
725 <td align=left>stop</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
726 <tr><td align=center><kbd>e</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
727 <td align=left>pause</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
728 <tr><td align=center><kbd>n</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
729 <td align=left>no sound</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
730 <tr><td align=center><kbd>m</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
731 <td align=left>mono sound</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
732 <tr><td align=center><kbd>t</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
733 <td align=left>stereo sound</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
734 <tr><td align=center><kbd>f</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
735 <td align=left>stream is a file</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
736 <tr><td align=center><kbd>v</kbd></td>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
737 <td align=left>stream is a Video CD</td></tr>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
738 <tr><td align=center><kbd>d</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
739 <td align=left>stream is a DVD</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
740 <tr><td align=center><kbd>u</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
741 <td align=left>stream is a URL</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
742 </table>
b190d3e9427c init version
pontscho
parents:
diff changeset
743
b190d3e9427c init version
pontscho
parents:
diff changeset
744
b190d3e9427c init version
pontscho
parents:
diff changeset
745 <h2><a name="guimsg">Appendix A: GUI messages</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
746
b190d3e9427c init version
pontscho
parents:
diff changeset
747 These are the messages that can be generated by buttons, potmeters and
b190d3e9427c init version
pontscho
parents:
diff changeset
748 menu entries.
b190d3e9427c init version
pontscho
parents:
diff changeset
749
b190d3e9427c init version
pontscho
parents:
diff changeset
750 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
751 <em class=note>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
752 <b>Note:</b> Some of the messages might not work as expected (or not work at
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
753 all). As you know, the GUI is under development.</em>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
754 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
755
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
756
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
757 <h3>Playback control:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
758 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
759 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
760 <dt><b>evNext</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
761 <dd>Jump to next track in the playlist.
b190d3e9427c init version
pontscho
parents:
diff changeset
762
b190d3e9427c init version
pontscho
parents:
diff changeset
763 <dt><b>evPause</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
764 <dd>Pause playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
765
b190d3e9427c init version
pontscho
parents:
diff changeset
766 <dt><b>evPauseSwitchToPlay</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
767 <dd>Forms a switch together with <code>evPlaySwitchToPause</code>. They can be
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
768 used to have a common play/pause button. Both messages should be assigned
b190d3e9427c init version
pontscho
parents:
diff changeset
769 to buttons displayed at the very same position in the window. This
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
770 message pauses playing and the image for the <code>evPlaySwitchToPause</code> button
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
771 is displayed (to indicate that the button can be pressed to continue playing).
b190d3e9427c init version
pontscho
parents:
diff changeset
772
b190d3e9427c init version
pontscho
parents:
diff changeset
773 <dt><b>evPlay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
774 <dd>Start playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
775
b190d3e9427c init version
pontscho
parents:
diff changeset
776 <dt><b>evPlaySwitchToPause</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
777 <dd>The opposite of <code>evPauseSwitchToPlay</code>. This message starts playing
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
778 and the image for the <code>evPauseSwitchToPlay</code> button is displayed (to
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
779 indicate that the button can be pressed to pause playing).
b190d3e9427c init version
pontscho
parents:
diff changeset
780
b190d3e9427c init version
pontscho
parents:
diff changeset
781 <dt><b>evPrev</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
782 <dd>Jump to previous track in the playlist.
b190d3e9427c init version
pontscho
parents:
diff changeset
783
b190d3e9427c init version
pontscho
parents:
diff changeset
784 <dt><b>evStop</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
785 <dd>Stop playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
786 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
787 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
788
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
789
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
790 <h3>Seeking:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
791 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
792 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
793 <dt><b>evBackward10sec</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
794 <dt><b>evBackward1min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
795 <dt><b>evBackward10min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
796 <dd>Seek backward 10 seconds / 1 minute / 10 minutes.
b190d3e9427c init version
pontscho
parents:
diff changeset
797
b190d3e9427c init version
pontscho
parents:
diff changeset
798 <dt><b>evForward10sec</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
799 <dt><b>evForward1min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
800 <dt><b>evForward10min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
801 <dd>Seek forward 10 seconds / 1 minute / 10 minutes.
b190d3e9427c init version
pontscho
parents:
diff changeset
802
b190d3e9427c init version
pontscho
parents:
diff changeset
803 <dt><b>evSetMoviePosition</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
804 <dd>Seek to position (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
805 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
806 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
807 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
808
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
809
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
810 <h3>Video control:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
811 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
812 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
813 <dt><b>evDoubleSize</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
814 <dd>Set the movie window to double size.
b190d3e9427c init version
pontscho
parents:
diff changeset
815
b190d3e9427c init version
pontscho
parents:
diff changeset
816 <dt><b>evFullScreen</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
817 <dd>Switch fullscreen mode on/off.
b190d3e9427c init version
pontscho
parents:
diff changeset
818
b190d3e9427c init version
pontscho
parents:
diff changeset
819 <dt><b>evNormalSize</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
820 <dd>Set the movie window to its normal size.
b190d3e9427c init version
pontscho
parents:
diff changeset
821 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
822 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
823
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
824
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
825 <h3>Audio control:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
826 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
827 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
828 <dt><b>evDecAudioBufDelay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
829 <dd>Decrease audio buffer delay.
b190d3e9427c init version
pontscho
parents:
diff changeset
830
b190d3e9427c init version
pontscho
parents:
diff changeset
831 <dt><b>evDecBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
832 <dd>Decrease balance.
b190d3e9427c init version
pontscho
parents:
diff changeset
833
b190d3e9427c init version
pontscho
parents:
diff changeset
834 <dt><b>evDecVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
835 <dd>Decrease volume.
b190d3e9427c init version
pontscho
parents:
diff changeset
836
b190d3e9427c init version
pontscho
parents:
diff changeset
837 <dt><b>evIncAudioBufDelay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
838 <dd>Increase audio buffer delay.
b190d3e9427c init version
pontscho
parents:
diff changeset
839
b190d3e9427c init version
pontscho
parents:
diff changeset
840 <dt><b>evIncBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
841 <dd>Increase balance.
b190d3e9427c init version
pontscho
parents:
diff changeset
842
b190d3e9427c init version
pontscho
parents:
diff changeset
843 <dt><b>evIncVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
844 <dd>Increase volume.
b190d3e9427c init version
pontscho
parents:
diff changeset
845
b190d3e9427c init version
pontscho
parents:
diff changeset
846 <dt><b>evMute</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
847 <dd>Mute/unmute the sound.
b190d3e9427c init version
pontscho
parents:
diff changeset
848
b190d3e9427c init version
pontscho
parents:
diff changeset
849 <dt><b>evSetBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
850 <dd>Set balance (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
851 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
852
b190d3e9427c init version
pontscho
parents:
diff changeset
853 <dt><b>evSetVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
854 <dd>Set volume (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
855 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
856 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
857 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
858
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
859
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
860 <h3>Miscellaneous:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
861 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
862 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
863 <dt><b>evAbout</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
864 <dd>Open the about window.
b190d3e9427c init version
pontscho
parents:
diff changeset
865
8316
gabucino
parents: 7814
diff changeset
866 <dt><b>evDropSubtitle</b>
gabucino
parents: 7814
diff changeset
867 <dd>Disables the currently used subtitle.
gabucino
parents: 7814
diff changeset
868
6726
672baf93b96a This event now has correct spelling.
diego
parents: 6557
diff changeset
869 <dt><b>evEqualizer</b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
870 <dd>Turn the equalizer on/off.
b190d3e9427c init version
pontscho
parents:
diff changeset
871
b190d3e9427c init version
pontscho
parents:
diff changeset
872 <dt><b>evExit</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
873 <dd>Quit the program.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
874
b190d3e9427c init version
pontscho
parents:
diff changeset
875 <dt><b>evIconify</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
876 <dd>Iconify the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
877
b190d3e9427c init version
pontscho
parents:
diff changeset
878 <dt><b>evLoad</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
879 <dd>Load a file (by opening a file browser window, where you can choose a
b190d3e9427c init version
pontscho
parents:
diff changeset
880 file).
b190d3e9427c init version
pontscho
parents:
diff changeset
881
b190d3e9427c init version
pontscho
parents:
diff changeset
882 <dt><b>evLoadPlay</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
883 <dd>Does the same as <code>evLoad</code>, but it automatically starts
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
884 playing after the file is loaded.
b190d3e9427c init version
pontscho
parents:
diff changeset
885
8316
gabucino
parents: 7814
diff changeset
886 <dt><b>evLoadSubtitle</b>
gabucino
parents: 7814
diff changeset
887 <dd>Loads a subtitle file (with the fileselector)
gabucino
parents: 7814
diff changeset
888
gabucino
parents: 7814
diff changeset
889 <dt><b>evLoadAudioFile</b>
gabucino
parents: 7814
diff changeset
890 <dd>Loads an audio file (with the fileselector)
gabucino
parents: 7814
diff changeset
891
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
892 <dt><b>evNone</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
893 <dd>Empty message, it has no effect (except maybe in CVS versions :-)).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
894
b190d3e9427c init version
pontscho
parents:
diff changeset
895 <dt><b>evPlayList</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
896 <dd>Open/close the playlist window.
b190d3e9427c init version
pontscho
parents:
diff changeset
897
8316
gabucino
parents: 7814
diff changeset
898 <dt><b>evPlayDVD</b>
8432
7b6b7fb76965 small updates
diego
parents: 8316
diff changeset
899 <dd>Tries to open the disc in the given DVD-ROM drive.
8316
gabucino
parents: 7814
diff changeset
900
gabucino
parents: 7814
diff changeset
901 <dt><b>evPlayVCD</b>
8432
7b6b7fb76965 small updates
diego
parents: 8316
diff changeset
902 <dd>Tries to open the disc in the given CD-ROM drive.
8316
gabucino
parents: 7814
diff changeset
903
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
904 <dt><b>evPreferences</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
905 <dd>Open the preferences window.
b190d3e9427c init version
pontscho
parents:
diff changeset
906
8316
gabucino
parents: 7814
diff changeset
907 <dt><b>evSetAspect</b>
gabucino
parents: 7814
diff changeset
908 <dd>Sets displayed image aspect.
gabucino
parents: 7814
diff changeset
909
gabucino
parents: 7814
diff changeset
910 <dt><b>evSetURL</b>
gabucino
parents: 7814
diff changeset
911 <dd>Displays the URL dialog window.
gabucino
parents: 7814
diff changeset
912
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
913 <dt><b>evSkinBrowser</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
914 <dd>Open the skin browser window.
b190d3e9427c init version
pontscho
parents:
diff changeset
915 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
916 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
917
b190d3e9427c init version
pontscho
parents:
diff changeset
918 </body>
b190d3e9427c init version
pontscho
parents:
diff changeset
919 </html>