annotate DOCS/skin.html @ 9061:b840039be057

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