1 Before reading this document, you should first take a look at skins-howto.txt
2 to understand general purpose about 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 attibutes 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 followings
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.
64 Action : Force refreshing of the interface.
68 Action : if VLC is not visible in system tray, show it, else, hide it.
72 Action : if VLC is not visible in taskbar, show it, else, hide it.
76 Action : switch current playing file to fullscreen mode.
84 Action : stop playing stream.
88 Action : pause the stream.
92 Action : go to next file in playlist.
96 Action : go to previous file in playlist.
103 Action : change sound volume.
105 1: - VLC_VOLUME_MUTE: switch to mute mode.
106 - VLC_VOLUME_UP: raise sounds volume.
108 - VLC_VOLUME_SET: set sound volume to second parameter
109 2: if first parameter is VLC_VOLUME_SET only, an integer between 0 and 100.
111 - VLC_PLAYLIST_ADD_FILE:
112 Action : Open an "open file dialog box" to add files to playlist.
116 Action : initiate manual window movement.
117 Parameters: only one which must match the ID of a window. It should be
118 used with image controls.
121 Action : open a window with a fading effect if selected.
122 Parameters: only one which must match the ID of a window.
125 Action : close a window with a fading effect if selected.
126 Parameters: only one who must match the ID of a window.
135 Action : hide/show a control.
137 1: ID of the control to hide/show.
138 2: Describe what to do. Nothing is showing control. TRUE is the same. FALSE
139 is hiding control. CHANGE is switching between this to state.
145 Action : moves a control.
147 1: ID of the control to move.
148 2: horizontal offset of movement.
149 3: vertical offset of movement.
152 Action : remove items from playlist.
154 1: ID of the playlist.
157 What to do with event ?
158 =======================
160 When creating your event, you must assign an ID to each of them.
161 Now you have to associate events with controls.
162 Some attributes of some controls are supposed to be filled with those IDs. That
163 is to say that when the action correspounding to the attribute will be done,
164 the event associated will be executed. The best exemple is assigning an event
165 to the 'onclick' attribute of a button control. The event will be executed when
166 clicking on the button.
167 You can execute several events. To do this you just have to separate them with
170 <ButtonControl [...] onclick="event1;event2;event3"/>
173 Do I have to create every event for each skin ?
174 ===============================================
176 No, a set of predefined events are present. Here they are with their ID and
179 ID Shortcut Description
181 tray CTRL+T Hide or show in the system tray.
182 taskbar CTRL+B Hide or show in the taskbar.
187 prev Z Previous file.
188 fullscreen F Switch to fullscreen mode.
192 quit CTRL+C Quit VLC.
193 open CTRL+O Open a file.
194 add_file CTRL+A Add a file.
195 load_skin CTRL+S Change skin.