Use var_InheritString for --decklink-video-connection.

[vlc] / doc / skins / events-howto.txt

diff --git a/doc/skins/events-howto.txt b/doc/skins/events-howto.txt
index a6de28e71f4c798a1056b4f4616cfcbc2ef0e48c..52f2c1c3c7d345601c59b2c00f777cd8dba38f0d 100644 (file)
--- a/doc/skins/events-howto.txt
+++ b/doc/skins/events-howto.txt
@@ -1,5 +1,5 @@
 Before reading this document, you should first take a look at skins-howto.txt
-to understand general purpose about VLC skins.
+to understand the general functioning of VLC skins.
 
 What is an event ?
 ==================
@@ -16,7 +16,7 @@ How to create an event ?
 ========================
 
 An event describes a simple action as seen above.
-All attibutes are explained in the 'skins-howto.txt' file except the 'event'
+All attributes are explained in the 'skins-howto.txt' file except the 'event'
 attribute wich is a bit special.
 In the 'event' attribute you will enter a simple script with the following
 syntax :
@@ -25,7 +25,7 @@ syntax :
 The number of parameters depends on EVENT.
 All this is case sensitive.
 Don't add spaces.
-EVENT is the action to execute, it can be one of the followings
+EVENT is the action to execute, it can be one of the following:
 
  - VLC_NOTHING:
    Action    : none, it executes nothing so don't use it !
@@ -54,6 +54,10 @@ EVENT is the action to execute, it can be one of the followings
    Action    : Open an "open file dialog box" to change the current skin.
    Parameters: none.
 
+ - VLC_ON_TOP:
+   Action    : Toggle the "Always on top" status
+   Parameters: none.
+
  - VLC_LOG_SHOW:
    Not supported yet
 
@@ -65,23 +69,23 @@ EVENT is the action to execute, it can be one of the followings
    Parameters: none.
 
  - VLC_CHANGE_TRAY:
-   Action    : if VLC is not visible in system tray, show it, else, hide it.
+   Action    : if VLC is not visible in system tray, show it, else hide it.
    Parameters: none.
 
  - VLC_CHANGE_TASKBAR:
-   Action    : if VLC is not visible in taskbar, show it, else, hide it.
+   Action    : if VLC is not visible in taskbar, show it, else hide it.
    Parameters: none.
 
  - VLC_FULLSCREEN:
-   Action    : switch current playing file to fullscreen mode.
+   Action    : switch current playlist item to fullscreen mode.
    Parameters: none.
 
  - VLC_PLAY:
-   Action    : play stream.
+   Action    : play the stream.
    Parameters: none.
 
  - VLC_STOP:
-   Action    : stop playing stream.
+   Action    : stop the stream.
    Parameters: none.
 
  - VLC_PAUSE:
@@ -89,11 +93,19 @@ EVENT is the action to execute, it can be one of the followings
    Parameters: none.
 
  - VLC_NEXT:
-   Action    : go to next file in playlist.
+   Action    : go to the next file in the playlist.
    Parameters: none.
 
  - VLC_PREV:
-   Action    : go to previous file in playlist.
+   Action    : go to the previous file in the playlist.
+   Parameters: none.
+
+ - VLC_SLOWER:
+   Action    : play the stream slower.
+   Parameters: none.
+
+ - VLC_FASTER:
+   Action    : play the stream faster.
    Parameters: none.
 
  - VLC_STREAMPOS:
@@ -119,11 +131,17 @@ EVENT is the action to execute, it can be one of the followings
 
  - VLC_WINDOW_OPEN:
    Action    : open a window with a fading effect if selected.
-   Parameters: only one which must match the ID of a window.
+   Parameters:
+     1: ID of the window to open.
+     2: Describe what to do. Nothing is opening. 'TRUE' is the same. 'FALSE' is
+        closing window. 'CHANGE' is switching between these two states.
 
  - VLC_WINDOW_CLOSE:
    Action    : close a window with a fading effect if selected.
-   Parameters: only one who must match the ID of a window.
+   Parameters:
+     1: ID of the window to close.
+     2: Describe what to do. Nothing is closing. 'TRUE' is the same. 'FALSE' is
+        opening window. 'CHANGE' is switching between these two states.
 
  - CTRL_SET_SLIDER:
    Not supported yet.
@@ -135,8 +153,9 @@ EVENT is the action to execute, it can be one of the followings
    Action    : hide/show a control.
    Parameters:
      1: ID of the control to hide/show.
-     2: Describe what to do. Nothing is showing control. TRUE is the same. FALSE
-        is hiding control. CHANGE is switching between this to state.
+     2: Describe what to do. Nothing is showing control. 'TRUE' is the same.
+        'FALSE' is hiding control. 'CHANGE' is switching between these two
+        states.
 
  - CTRL_ID_ENABLED:
    Not supported yet.
@@ -154,13 +173,13 @@ EVENT is the action to execute, it can be one of the followings
      1: ID of the playlist.
 
 
-What to do with event ?
+What to do with events ?
 =======================
 
 When creating your event, you must assign an ID to each of them.
 Now you have to associate events with controls.
 Some attributes of some controls are supposed to be filled with those IDs. That
-is to say that when the action correspounding to the attribute will be done,
+is to say that when the action corresponding to the attribute will be done,
 the event associated will be executed. The best exemple is assigning an event
 to the 'onclick' attribute of a button control. The event will be executed when
 clicking on the button.
@@ -178,13 +197,15 @@ shortcut.
 
   ID           Shortcut     Description
 
-  tray         CTRL+T       Hide or show in the system tray.
+  tray                      Hide or show in the system tray.
   taskbar      CTRL+B       Hide or show in the taskbar.
   play         X            Play.
   pause        C            Pause.
   stop         V            Stop.
   next         B            Next file.
   prev         Z            Previous file.
+  slow                      Play slower.
+  fast                      Play faster.
   fullscreen   F            Switch to fullscreen mode.
   mute                      Mute the sound.
   volume_up
@@ -193,4 +214,9 @@ shortcut.
   open         CTRL+O       Open a file.
   add_file     CTRL+A       Add a file.
   load_skin    CTRL+S       Change skin.
+  on_top       CTRL+T       Toggle the "Always on top" status
+  show_prefs                Show the preferences dialog box.
+  show_info                 Show the FileInfo dialog box.
+  show_log                  Show the Messages dialog box.
+  hide_log                  Hide the Messages dialog box.