annotate DOCS/skin.html @ 7715:9774d0733dfa

src and dest buffers may overlap
author pl
date Fri, 11 Oct 2002 23:55:04 +0000
parents f3f87f6bf5cf
children 988498df1996
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
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
58 The purpose of this document is to describe the <b>MPlayer</b> skin format.
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">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
62 <li>It is not me who wrote the GUI</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
63 <li>The GUI is not finished</li>
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
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
81 know that <b>MPlayer</b> has <b>no</b> builtin skin, so <b>at least one skin
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>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
95 Note that the first path may vary according to the way <b>MPlayer</b> was
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
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
109 Images must be truecolor (24 or 32 bpp) and can be in BMP, PNG or uncompressed
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
110 TGA format. The preferred format is PNG as it compresses very well.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
111
b190d3e9427c init version
pontscho
parents:
diff changeset
112 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
113 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
114 Regions filled with the color #FF00FF (<font color="#FF00FF">magenta</font>)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
115 are fully transparent when viewed by <b>MPlayer</b>. This means that you can even
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
116 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
117 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
118
b190d3e9427c init version
pontscho
parents:
diff changeset
119
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
120 <h3><a name="components">2.3 Skin components</a></h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
121
b190d3e9427c init version
pontscho
parents:
diff changeset
122 Skins are quite free-format (unlike the fixed-format skins of
b190d3e9427c init version
pontscho
parents:
diff changeset
123 Winamp/XMMS, for example), so it is up to you to create something great.
b190d3e9427c init version
pontscho
parents:
diff changeset
124
b190d3e9427c init version
pontscho
parents:
diff changeset
125 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
126 Currently there are three windows to be decorated: the
b190d3e9427c init version
pontscho
parents:
diff changeset
127 <a href="#mainwin">main window</a>, the <a href="#subwindow">subwindow</a> and
b190d3e9427c init version
pontscho
parents:
diff changeset
128 the <a href="#skinmenu">skin menu</a> (which can be activated by a right
b190d3e9427c init version
pontscho
parents:
diff changeset
129 click).
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
130 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
131
b190d3e9427c init version
pontscho
parents:
diff changeset
132 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
133 <li>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
134 The <b>main window</b> is where you can control <b>MPlayer</b>. The background of
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
135 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
136 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
137 <em>labels</em>. For every item, you must
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
138 specify its position and size.
b190d3e9427c init version
pontscho
parents:
diff changeset
139
b190d3e9427c init version
pontscho
parents:
diff changeset
140 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
141 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
142 disabled), thus its image must be divided into three parts vertically.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
143 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
144 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
145
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
146 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
147 A <b>potmeter</b> (mainly used for the seek bar and volume/balance
b190d3e9427c init version
pontscho
parents:
diff changeset
148 control) can have any number of phases by dividing its image into different
b190d3e9427c init version
pontscho
parents:
diff changeset
149 parts below each other.
b190d3e9427c init version
pontscho
parents:
diff changeset
150 See <a href="#main.hpotmeter">hpotmeter</a> and
b190d3e9427c init version
pontscho
parents:
diff changeset
151 <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
152 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
153
b190d3e9427c init version
pontscho
parents:
diff changeset
154 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
155 <b>Labels</b> are a bit special: The characters needed to draw them are taken
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
156 from an image file, and the characters in the image are described
b190d3e9427c init version
pontscho
parents:
diff changeset
157 by a <a href="#fonts">font description file</a>.
b190d3e9427c init version
pontscho
parents:
diff changeset
158 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
159 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
160 image file and its font description file form a font <em>together</em>).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
161 See <a href="#main.dlabel">dlabel</a> and <a href="#main.slabel">slabel</a>
b190d3e9427c init version
pontscho
parents:
diff changeset
162 for details.
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
163 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
164
b190d3e9427c init version
pontscho
parents:
diff changeset
165 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
166 <em class=note>
b190d3e9427c init version
pontscho
parents:
diff changeset
167 <b>Note:</b> all images can have full transparency as described in the
b190d3e9427c init version
pontscho
parents:
diff changeset
168 section about <a href="#images">image formats</a>.
b190d3e9427c init version
pontscho
parents:
diff changeset
169 </em>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
170 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
171 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
172
b190d3e9427c init version
pontscho
parents:
diff changeset
173 <li>
b190d3e9427c init version
pontscho
parents:
diff changeset
174 The <b>subwindow</b> is where the movie appears. It can display a specified
b190d3e9427c init version
pontscho
parents:
diff changeset
175 image if there is no movie loaded (it is quite boring to have an empty
b190d3e9427c init version
pontscho
parents:
diff changeset
176 window :-))
b190d3e9427c init version
pontscho
parents:
diff changeset
177 <em class=note><b>Note:</b> transparency
b190d3e9427c init version
pontscho
parents:
diff changeset
178 is <b>not allowed</b> here.</em>
b190d3e9427c init version
pontscho
parents:
diff changeset
179 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
180
b190d3e9427c init version
pontscho
parents:
diff changeset
181 <li>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
182 The <b>skin menu</b> is just a way to control <b>MPlayer</b> by means of
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
183 menu entries. Two images are required for the menu: one of them is the base
b190d3e9427c init version
pontscho
parents:
diff changeset
184 image that shows the menu in its normal state, the other one is used to
b190d3e9427c init version
pontscho
parents:
diff changeset
185 display the selected entries. When you pop up the menu, the first image is
b190d3e9427c init version
pontscho
parents:
diff changeset
186 shown. If you move the mouse over the menu entries, the currently selected
b190d3e9427c init version
pontscho
parents:
diff changeset
187 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
188 pointer (the second image is never shown as a whole).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
189 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
190 A menu entry is defined by its position and size in the image (see the
b190d3e9427c init version
pontscho
parents:
diff changeset
191 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
192 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
193 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
194 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
195
b190d3e9427c init version
pontscho
parents:
diff changeset
196 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
197 There is an important thing not mentioned yet: For buttons, potmeters and
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
198 menu entries to work, <b>MPlayer</b> must know what to do if they are clicked.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
199 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
200 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
201 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
202
b190d3e9427c init version
pontscho
parents:
diff changeset
203 <h3><a name="files">2.4 Files</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
204
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
205 You need the following files to build a skin:
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
206 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
207 <li>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
208 The configuration file named <a href="#skin">skin</a> tells <b>MPlayer</b> how
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
209 to put different parts of the skin together and what to do if you click
b190d3e9427c init version
pontscho
parents:
diff changeset
210 somewhere in the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
211 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
212 <li>The background image for the main window.</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
213 <li>Images for the items in the main window (including one or more font
b190d3e9427c init version
pontscho
parents:
diff changeset
214 description files needed to draw labels).</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
215 <li>The image to be displayed in the subwindow (optional).</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
216 <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
217 a menu).</li>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
218 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
219
b190d3e9427c init version
pontscho
parents:
diff changeset
220 With the exception of the skin configuration file, you can name the other
b190d3e9427c init version
pontscho
parents:
diff changeset
221 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
222 a <code>.fnt</code> extension).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
223
b190d3e9427c init version
pontscho
parents:
diff changeset
224
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
225 <h2><a name="skin">3 The <code>skin</code> file</a></h2>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
226
b190d3e9427c init version
pontscho
parents:
diff changeset
227 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
228 As mentioned above, this is the skin configuration file.
b190d3e9427c init version
pontscho
parents:
diff changeset
229 It is line oriented; comment lines start with a '<code>;</code>' character
b190d3e9427c init version
pontscho
parents:
diff changeset
230 at the beginning of the line (only spaces and tabs are allowed before the
b190d3e9427c init version
pontscho
parents:
diff changeset
231 '<code>;</code>').
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
232 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
233
b190d3e9427c init version
pontscho
parents:
diff changeset
234 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
235 The file is made up of sections. Each section describes the skin for an
b190d3e9427c init version
pontscho
parents:
diff changeset
236 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
237 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
238
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
239 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
240 section = <i>section name</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
241 .
b190d3e9427c init version
pontscho
parents:
diff changeset
242 .
b190d3e9427c init version
pontscho
parents:
diff changeset
243 .
b190d3e9427c init version
pontscho
parents:
diff changeset
244 end
b190d3e9427c init version
pontscho
parents:
diff changeset
245 </pre></td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
246
b190d3e9427c init version
pontscho
parents:
diff changeset
247 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
248 Currently there is only one application, so you need only one section:
b190d3e9427c init version
pontscho
parents:
diff changeset
249 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
250 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
251
b190d3e9427c init version
pontscho
parents:
diff changeset
252 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
253 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
254 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
255
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
256 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
257 window = <i>window name</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
258 .
b190d3e9427c init version
pontscho
parents:
diff changeset
259 .
b190d3e9427c init version
pontscho
parents:
diff changeset
260 .
b190d3e9427c init version
pontscho
parents:
diff changeset
261 end
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
262 </pre></td></tr></table>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
263
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
264 <p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
265 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
266 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
267
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
268 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
269 <li><b>main</b> - for the main window</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
270 <li><b>sub</b> - for the subwindow</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
271 <li><b>menu</b> - for the skin menu</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
272 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
273
b190d3e9427c init version
pontscho
parents:
diff changeset
274 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
275 (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
276 decorate the subwindow.)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
277 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
278
b190d3e9427c init version
pontscho
parents:
diff changeset
279 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
280 Within a window block, you can define each item for the window
b190d3e9427c init version
pontscho
parents:
diff changeset
281 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
282 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
283
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
284 <dl>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
285 <dt>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
286 <b><code>item = parameter</code></b>
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 <dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
289 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
290 <code>parameter</code> is a numeric or textual value (or a list of values
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
291 separated by commas).
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
292 </dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
293 </dl>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
294
b190d3e9427c init version
pontscho
parents:
diff changeset
295 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
296 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
297 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
298
b190d3e9427c init version
pontscho
parents:
diff changeset
299 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
300 section = movieplayer
b190d3e9427c init version
pontscho
parents:
diff changeset
301 window = main
b190d3e9427c init version
pontscho
parents:
diff changeset
302 ; ... items for main window ...
b190d3e9427c init version
pontscho
parents:
diff changeset
303 end
b190d3e9427c init version
pontscho
parents:
diff changeset
304
b190d3e9427c init version
pontscho
parents:
diff changeset
305 window = sub
b190d3e9427c init version
pontscho
parents:
diff changeset
306 ; ... items for subwindow ...
b190d3e9427c init version
pontscho
parents:
diff changeset
307 end
b190d3e9427c init version
pontscho
parents:
diff changeset
308
b190d3e9427c init version
pontscho
parents:
diff changeset
309 window = menu
b190d3e9427c init version
pontscho
parents:
diff changeset
310 ; ... items for skin menu ...
b190d3e9427c init version
pontscho
parents:
diff changeset
311 end
b190d3e9427c init version
pontscho
parents:
diff changeset
312 end
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
313 </pre></td></tr></table>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
314
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
315 <p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
316 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
317 searched for in the <code>Skin</code> directory. You may (but you need not)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
318 specify the extension of the file. If the file does not exist, <b>MPlayer</b>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
319 tries to load the file <code>&lt;filename&gt;.&lt;ext&gt;</code>, where
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
320 <code>tga</code>, <code>TGA</code>, <code>bmp</code>, <code>BMP</code>,
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
321 <code>png</code> and <code>PNG</code> is tried for <code>&lt;ext&gt;</code>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
322 (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
323 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
324
b190d3e9427c init version
pontscho
parents:
diff changeset
325 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
326 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
327 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
328 <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
329 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
330 </p>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
331
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
332 <pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
333
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
334 (0, 0)----(-1, 0)----(-2, 0)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
335 | | |
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 (0,-1)----(-1,-1)----(-2,-1)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
338 | | |
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 (0,-2)----(-1,-2)----(-2,-2)
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
341
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
342 </pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
343
b190d3e9427c init version
pontscho
parents:
diff changeset
344 <table border=1 cellpadding=5 width="100%"><tr bgcolor="#ffffcc"><td>
b190d3e9427c init version
pontscho
parents:
diff changeset
345 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
346 <code>main.png</code> that you use for the main window:
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
347 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
348 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
349 base = main, -1, -1
b190d3e9427c init version
pontscho
parents:
diff changeset
350 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
351 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
352
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
353 <b>MPlayer</b> tries to load <code>main</code>, <code>main.tga</code>,
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
354 <code>main.TGA</code>, <code>main.bmp</code> etc, so that <code>main.png</code>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
355 will be found.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
356 <br>
b190d3e9427c init version
pontscho
parents:
diff changeset
357 If (by accident) you wrote
b190d3e9427c init version
pontscho
parents:
diff changeset
358 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
359 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
360 base = main.bmp, -1, -1
b190d3e9427c init version
pontscho
parents:
diff changeset
361 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
362 </blockquote>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
363 then <code>main.bmp</code>, <code>main.bmp.tga</code>, <code>main.bmp.TGA</code>,
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
364 <code>main.bmp.bmp</code> would be searched for and <b>MPlayer</b> would finally
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
365 give up because there is no <code>main.bmp</code> in the directory, only
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
366 <code>main.png</code>.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
367 </td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
368
b190d3e9427c init version
pontscho
parents:
diff changeset
369
b190d3e9427c init version
pontscho
parents:
diff changeset
370 <h3><a name="mainwin">3.1 Main window</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
371
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
372 Below is the list of entries that can be used in the
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
373 '<code>window = main</code>' .&nbsp;.&nbsp;. '<code>end</code>' block.
b190d3e9427c init version
pontscho
parents:
diff changeset
374
b190d3e9427c init version
pontscho
parents:
diff changeset
375 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
376 <dt><a name="main.base">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
377 <b><code>base = image, X, Y</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
378 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
379 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
380 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
381 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
382 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
383 <div>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
384 <em class=warn>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
385 <b>Warning:</b> Transparent regions in the image (colored #FF00FF) appear
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
386 black on X servers without the XShape extension.
b190d3e9427c init version
pontscho
parents:
diff changeset
387 </em>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
388 </div>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
389 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
390
b190d3e9427c init version
pontscho
parents:
diff changeset
391 <dt><a name="main.button">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
392 <b><code>button = image, X, Y, width, height, message</code></b></a></dt>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
393 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
394 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
395 <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
396 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
397 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
398 like this:
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
399 <pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
400 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
401 | pressed |
b190d3e9427c init version
pontscho
parents:
diff changeset
402 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
403 | released |
b190d3e9427c init version
pontscho
parents:
diff changeset
404 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
405 | disabled |
b190d3e9427c init version
pontscho
parents:
diff changeset
406 +------------+
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
407 </pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
408 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
409
b190d3e9427c init version
pontscho
parents:
diff changeset
410 <dt><a name="main.decoration">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
411 <b><code>decoration = enable|disable</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
412 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
413 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
414 Enable or disable window manager decoration of the main window. Default
b190d3e9427c init version
pontscho
parents:
diff changeset
415 is <b>disable</b>.
b190d3e9427c init version
pontscho
parents:
diff changeset
416 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
417
b190d3e9427c init version
pontscho
parents:
diff changeset
418 <dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
419 <a name="main.hpotmeter">
b190d3e9427c init version
pontscho
parents:
diff changeset
420 <b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
421 <code>hpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message</code>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
422 </b>
b190d3e9427c init version
pontscho
parents:
diff changeset
423 </a>
b190d3e9427c init version
pontscho
parents:
diff changeset
424 </dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
425 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
426 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
427 at position <code>X</code>,<code>Y</code>. The image can be divided into
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
428 different parts for the different phases of the potmeter (for example,
b190d3e9427c init version
pontscho
parents:
diff changeset
429 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
430 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
431 <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
432
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
433 <div>The parameters are:</div>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
434
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
435 <ul>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
436 <li><code>button</code> - the image to be used for the button
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
437 (must have three parts below each other, like in case of
b190d3e9427c init version
pontscho
parents:
diff changeset
438 <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
439 <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
440 <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
441 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
442 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
443 vertically like this:
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
444 <pre>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
445 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
446 | phase #1 |
b190d3e9427c init version
pontscho
parents:
diff changeset
447 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
448 | phase #2 |
b190d3e9427c init version
pontscho
parents:
diff changeset
449 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
450 ...
b190d3e9427c init version
pontscho
parents:
diff changeset
451 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
452 | phase #n |
b190d3e9427c init version
pontscho
parents:
diff changeset
453 +------------+
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
454 </pre>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
455 </li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
456 <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
457 image</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
458 <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
459 100)</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
460 <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
461 <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
462 <code>hpotmeter</code></li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
463 <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
464 <code>hpotmeter</code> is changed</li>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
465 </ul>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
466
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
467 <em class=note>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
468 <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
469 implemented yet.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
470 </em>
b190d3e9427c init version
pontscho
parents:
diff changeset
471 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
472
b190d3e9427c init version
pontscho
parents:
diff changeset
473 <dt><a name="main.potmeter">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
474 <b><code>potmeter = phases, numphases, default, X, Y, width, height, message</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
475 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
476 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
477 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
478 around, but it reacts to horizontal dragging only.)
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
479 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
480 <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
481 <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
482 the <code>potmeter</code> is set.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
483 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
484
b190d3e9427c init version
pontscho
parents:
diff changeset
485 <dt><a name="main.font">
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
486 <b><code>font = fontfile, fontid</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
487 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
488 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
489 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
490 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
491 <code>fontid</code> is used to refer to the font
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
492 (see <a href="#main.dlabel">dlabel</a> and <a href="#main.slabel">slabel</a>).
b190d3e9427c init version
pontscho
parents:
diff changeset
493 Up to 25 fonts can be defined.
b190d3e9427c init version
pontscho
parents:
diff changeset
494 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
495
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
496 <dt><a name="main.slabel">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
497 <b><code>slabel = X, Y, fontid, "text"</code></b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
498 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
499 <dd>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
500 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
501 <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
502 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
503 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
504 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
505 <code>fontid</code>.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
506 </dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
507
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
508 <dt><a name="main.dlabel">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
509 <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
510 </a></dt>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
511 <dd>
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
512 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
513 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
514 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
515 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
516 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
517 <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
518 center, <code>2</code> is for left.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
519 <br>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
520 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
521 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
522 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
523 You can use the following variables in the text:
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
524
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
525 <table align="center" border="1">
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
526 <tr align=center><th>Variable</th><th align=left>Meaning</th></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
527 <tr><td align=center><kbd>$1</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
528 <td>play time in <em>hh:mm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
529 <tr><td align=center><kbd>$2</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
530 <td>play time in <em>mmmm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
531 <tr><td align=center><kbd>$3</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
532 <td>play time in <em>hh</em> format (hours)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
533 <tr><td align=center><kbd>$4</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
534 <td>play time in <em>mm</em> format (minutes)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
535 <tr><td align=center><kbd>$5</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
536 <td>play time in <em>ss</em> format (seconds)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
537 <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
538 <td>movie length in <em>hh:mm:ss</em> format</td></tr>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
539 <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
540 <td>movie length in <em>mmmm:ss</em> format</td></tr>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
541 <tr><td align=center><kbd>$8</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
542 <td>play time in <em>h:mm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
543 <tr><td align=center><kbd>$v</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
544 <td>volume in <em>xxx.xx%</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
545 <tr><td align=center><kbd>$V</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
546 <td>volume in <em>xxx.x</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
547 <tr><td align=center><kbd>$b</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
548 <td>balance in <em>xxx.xx%</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
549 <tr><td align=center><kbd>$B</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
550 <td>balance in <em>xxx.x</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
551 <tr><td align=center><kbd>$$</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
552 <td>the <kbd>$</kbd> character</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
553 <tr><td align=center><kbd>$a</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
554 <td>a character according to the audio type (none: <code>n</code>,
b190d3e9427c init version
pontscho
parents:
diff changeset
555 mono: <code>m</code>, stereo: <code>t</code>)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
556 <tr><td align=center><kbd>$t</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
557 <td>track number (in playlist)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
558 <tr><td align=center><kbd>$o</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
559 <td>filename</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
560 <tr><td align=center><kbd>$f</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
561 <td>filename in lower case</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
562 <tr><td align=center><kbd>$F</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
563 <td>filename in upper case</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
564 <tr><td align=center><kbd>$T</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
565 <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
566 Video CD: <code>v</code>, DVD: <code>d</code>, URL: <code>u</code>)
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
567 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
568 <tr><td align=center><kbd>$p</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
569 <td>the "p" character (if a movie is playing and the font has the "p"
b190d3e9427c init version
pontscho
parents:
diff changeset
570 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
571 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
572 <tr><td align=center><kbd>$s</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
573 <td>the "s" character (if the movie is stopped and the font has the "s"
b190d3e9427c init version
pontscho
parents:
diff changeset
574 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
575 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
576 <tr><td align=center><kbd>$e</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
577 <td>the "e" character (if playback is paused and the font has the "e"
b190d3e9427c init version
pontscho
parents:
diff changeset
578 character)
b190d3e9427c init version
pontscho
parents:
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 <p>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
745 <em class="note">
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
746 <b>Note:</b> Currently only 'p', 's', 'e', 'n', 'm' and 't' are used.
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
747 </em>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
748 </p>
b190d3e9427c init version
pontscho
parents:
diff changeset
749
b190d3e9427c init version
pontscho
parents:
diff changeset
750 <h2><a name="guimsg">Appendix A: GUI messages</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
751
b190d3e9427c init version
pontscho
parents:
diff changeset
752 These are the messages that can be generated by buttons, potmeters and
b190d3e9427c init version
pontscho
parents:
diff changeset
753 menu entries.
b190d3e9427c init version
pontscho
parents:
diff changeset
754
b190d3e9427c init version
pontscho
parents:
diff changeset
755 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
756 <em class=note>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
757 <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
758 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
759 </p>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
760
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
761
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
762 <h3>Playback control:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
763 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
764 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
765 <dt><b>evNext</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
766 <dd>Jump to next track in the playlist.
b190d3e9427c init version
pontscho
parents:
diff changeset
767
b190d3e9427c init version
pontscho
parents:
diff changeset
768 <dt><b>evPause</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
769 <dd>Pause playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
770
b190d3e9427c init version
pontscho
parents:
diff changeset
771 <dt><b>evPauseSwitchToPlay</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
772 <dd>Forms a switch together with <code>evPlaySwitchToPause</code>. They can be
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
773 used to have a common play/pause button. Both messages should be assigned
b190d3e9427c init version
pontscho
parents:
diff changeset
774 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
775 message pauses playing and the image for the <code>evPlaySwitchToPause</code> button
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
776 is displayed (to indicate that the button can be pressed to continue playing).
b190d3e9427c init version
pontscho
parents:
diff changeset
777
b190d3e9427c init version
pontscho
parents:
diff changeset
778 <dt><b>evPlay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
779 <dd>Start playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
780
b190d3e9427c init version
pontscho
parents:
diff changeset
781 <dt><b>evPlaySwitchToPause</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
782 <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
783 and the image for the <code>evPauseSwitchToPlay</code> button is displayed (to
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
784 indicate that the button can be pressed to pause playing).
b190d3e9427c init version
pontscho
parents:
diff changeset
785
b190d3e9427c init version
pontscho
parents:
diff changeset
786 <dt><b>evPrev</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
787 <dd>Jump to previous track in the playlist.
b190d3e9427c init version
pontscho
parents:
diff changeset
788
b190d3e9427c init version
pontscho
parents:
diff changeset
789 <dt><b>evStop</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
790 <dd>Stop playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
791 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
792 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
793
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
794
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
795 <h3>Seeking:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
796 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
797 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
798 <dt><b>evBackward10sec</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
799 <dt><b>evBackward1min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
800 <dt><b>evBackward10min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
801 <dd>Seek backward 10 seconds / 1 minute / 10 minutes.
b190d3e9427c init version
pontscho
parents:
diff changeset
802
b190d3e9427c init version
pontscho
parents:
diff changeset
803 <dt><b>evForward10sec</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
804 <dt><b>evForward1min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
805 <dt><b>evForward10min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
806 <dd>Seek forward 10 seconds / 1 minute / 10 minutes.
b190d3e9427c init version
pontscho
parents:
diff changeset
807
b190d3e9427c init version
pontscho
parents:
diff changeset
808 <dt><b>evSetMoviePosition</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
809 <dd>Seek to position (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
810 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
811 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
812 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
813
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
814
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
815 <h3>Video control:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
816 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
817 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
818 <dt><b>evDoubleSize</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
819 <dd>Set the movie window to double size.
b190d3e9427c init version
pontscho
parents:
diff changeset
820
b190d3e9427c init version
pontscho
parents:
diff changeset
821 <dt><b>evFullScreen</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
822 <dd>Switch fullscreen mode on/off.
b190d3e9427c init version
pontscho
parents:
diff changeset
823
b190d3e9427c init version
pontscho
parents:
diff changeset
824 <dt><b>evNormalSize</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
825 <dd>Set the movie window to its normal size.
b190d3e9427c init version
pontscho
parents:
diff changeset
826 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
827 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
828
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
829
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
830 <h3>Audio control:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
831 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
832 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
833 <dt><b>evDecAudioBufDelay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
834 <dd>Decrease audio buffer delay.
b190d3e9427c init version
pontscho
parents:
diff changeset
835
b190d3e9427c init version
pontscho
parents:
diff changeset
836 <dt><b>evDecBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
837 <dd>Decrease balance.
b190d3e9427c init version
pontscho
parents:
diff changeset
838
b190d3e9427c init version
pontscho
parents:
diff changeset
839 <dt><b>evDecVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
840 <dd>Decrease volume.
b190d3e9427c init version
pontscho
parents:
diff changeset
841
b190d3e9427c init version
pontscho
parents:
diff changeset
842 <dt><b>evIncAudioBufDelay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
843 <dd>Increase audio buffer delay.
b190d3e9427c init version
pontscho
parents:
diff changeset
844
b190d3e9427c init version
pontscho
parents:
diff changeset
845 <dt><b>evIncBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
846 <dd>Increase balance.
b190d3e9427c init version
pontscho
parents:
diff changeset
847
b190d3e9427c init version
pontscho
parents:
diff changeset
848 <dt><b>evIncVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
849 <dd>Increase volume.
b190d3e9427c init version
pontscho
parents:
diff changeset
850
b190d3e9427c init version
pontscho
parents:
diff changeset
851 <dt><b>evMute</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
852 <dd>Mute/unmute the sound.
b190d3e9427c init version
pontscho
parents:
diff changeset
853
b190d3e9427c init version
pontscho
parents:
diff changeset
854 <dt><b>evSetBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
855 <dd>Set balance (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
856 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
857
b190d3e9427c init version
pontscho
parents:
diff changeset
858 <dt><b>evSetVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
859 <dd>Set volume (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
860 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
861 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
862 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
863
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
864
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
865 <h3>Miscellaneous:</h3>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
866 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
867 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
868 <dt><b>evAbout</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
869 <dd>Open the about window.
b190d3e9427c init version
pontscho
parents:
diff changeset
870
6726
672baf93b96a This event now has correct spelling.
diego
parents: 6557
diff changeset
871 <dt><b>evEqualizer</b>
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
872 <dd>Turn the equalizer on/off.
b190d3e9427c init version
pontscho
parents:
diff changeset
873
b190d3e9427c init version
pontscho
parents:
diff changeset
874 <dt><b>evExit</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
875 <dd>Quit the program.
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
876
b190d3e9427c init version
pontscho
parents:
diff changeset
877 <dt><b>evIconify</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
878 <dd>Iconify the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
879
b190d3e9427c init version
pontscho
parents:
diff changeset
880 <dt><b>evLoad</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
881 <dd>Load a file (by opening a file browser window, where you can choose a
b190d3e9427c init version
pontscho
parents:
diff changeset
882 file).
b190d3e9427c init version
pontscho
parents:
diff changeset
883
b190d3e9427c init version
pontscho
parents:
diff changeset
884 <dt><b>evLoadPlay</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
885 <dd>Does the same as <code>evLoad</code>, but it automatically starts
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
886 playing after the file is loaded.
b190d3e9427c init version
pontscho
parents:
diff changeset
887
b190d3e9427c init version
pontscho
parents:
diff changeset
888 <dt><b>evNone</b>
6271
b85d324d4503 Grammar, spellchecking and HTML fixups as usual, as well as an explanatory
diego
parents: 1982
diff changeset
889 <dd>Empty message, it has no effect (except maybe in CVS versions :-)).
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
890
b190d3e9427c init version
pontscho
parents:
diff changeset
891 <dt><b>evPlayList</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
892 <dd>Open/close the playlist window.
b190d3e9427c init version
pontscho
parents:
diff changeset
893
b190d3e9427c init version
pontscho
parents:
diff changeset
894 <dt><b>evPreferences</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
895 <dd>Open the preferences window.
b190d3e9427c init version
pontscho
parents:
diff changeset
896
b190d3e9427c init version
pontscho
parents:
diff changeset
897 <dt><b>evSkinBrowser</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
898 <dd>Open the skin browser window.
b190d3e9427c init version
pontscho
parents:
diff changeset
899 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
900 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
901
b190d3e9427c init version
pontscho
parents:
diff changeset
902 </body>
b190d3e9427c init version
pontscho
parents:
diff changeset
903 </html>