1 Before reading this document, you should first take a look at skins-howto.txt
2 to understand the general functioning of VLC skins.
7 Events are the dynamic part of the skins. It means that beyond visual aspect,
8 the interface must react with the user actions. An event describes a simple
9 interaction, in fact one simple action such as playing a file, hiding a
11 So when designing a skin you will have to specify what those interactions are.
12 For this you will use simple actions that are described in event tags and you
13 would be able to add them and associate them to controls.
15 How to create an event ?
16 ========================
18 An event describes a simple action as seen above.
19 All attributes are explained in the 'skins-howto.txt' file except the 'event'
20 attribute wich is a bit special.
21 In the 'event' attribute you will enter a simple script with the following
23 "EVENT(parameter1,parameter2,...)"
25 The number of parameters depends on EVENT.
26 All this is case sensitive.
28 EVENT is the action to execute, it can be one of the following:
31 Action : none, it executes nothing so don't use it !
35 Action : Open all windows of the interface with a fading effect if
40 Action : Close all windows of the interface with a fading effect if
43 - First 1 is an EVENT to execute when all windows have been closed.
46 Action : Quit the interface
50 Action : Open an "open file dialog box" to open a file to play.
54 Action : Open an "open file dialog box" to change the current skin.
58 Action : Toggle the "Always on top" status
68 Action : Force refreshing of the interface.
72 Action : if VLC is not visible in system tray, show it, else hide it.
76 Action : if VLC is not visible in taskbar, show it, else hide it.
80 Action : switch current playlist item to fullscreen mode.
84 Action : play the stream.
88 Action : stop the stream.
92 Action : pause the stream.
96 Action : go to the next file in the playlist.
100 Action : go to the previous file in the playlist.
107 Action : change sound volume.
109 1: - VLC_VOLUME_MUTE: switch to mute mode.
110 - VLC_VOLUME_UP: raise sounds volume.
112 - VLC_VOLUME_SET: set sound volume to second parameter
113 2: if first parameter is VLC_VOLUME_SET only, an integer between 0 and 100.
115 - VLC_PLAYLIST_ADD_FILE:
116 Action : Open an "open file dialog box" to add files to playlist.
120 Action : initiate manual window movement.
121 Parameters: only one which must match the ID of a window. It should be
122 used with image controls.
125 Action : open a window with a fading effect if selected.
127 1: ID of the window to open.
128 2: Describe what to do. Nothing is opening. 'TRUE' is the same. 'FALSE' is
129 closing window. 'CHANGE' is switching between these two states.
132 Action : close a window with a fading effect if selected.
134 1: ID of the window to close.
135 2: Describe what to do. Nothing is closing. 'TRUE' is the same. 'FALSE' is
136 opening window. 'CHANGE' is switching between these two states.
145 Action : hide/show a control.
147 1: ID of the control to hide/show.
148 2: Describe what to do. Nothing is showing control. 'TRUE' is the same.
149 'FALSE' is hiding control. 'CHANGE' is switching between these two
156 Action : moves a control.
158 1: ID of the control to move.
159 2: horizontal offset of movement.
160 3: vertical offset of movement.
163 Action : remove items from playlist.
165 1: ID of the playlist.
168 What to do with events ?
169 =======================
171 When creating your event, you must assign an ID to each of them.
172 Now you have to associate events with controls.
173 Some attributes of some controls are supposed to be filled with those IDs. That
174 is to say that when the action corresponding to the attribute will be done,
175 the event associated will be executed. The best exemple is assigning an event
176 to the 'onclick' attribute of a button control. The event will be executed when
177 clicking on the button.
178 You can execute several events. To do this you just have to separate them with
181 <ButtonControl [...] onclick="event1;event2;event3"/>
184 Do I have to create every event for each skin ?
185 ===============================================
187 No, a set of predefined events are present. Here they are with their ID and
190 ID Shortcut Description
192 tray Hide or show in the system tray.
193 taskbar CTRL+B Hide or show in the taskbar.
198 prev Z Previous file.
199 fullscreen F Switch to fullscreen mode.
203 quit CTRL+C Quit VLC.
204 open CTRL+O Open a file.
205 add_file CTRL+A Add a file.
206 load_skin CTRL+S Change skin.
207 on_top CTRL+T Toggle the "Always on top" status
208 show_prefs Show the preferences dialog box.
209 show_info Show the FileInfo dialog box.
210 show_log Show the Messages dialog box.
211 hide_log Hide the Messages dialog box.