X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=doc%2Fskins%2Fskins2-howto.xml;h=1ce25af3c2134c31db911c19f5021ec70f4f5d7e;hb=e3aa4d0b12c75c76617c88f520969ae71d22473a;hp=fb79f340a4a1a64bb109bc04d0ff45052d4fec34;hpb=2594aeded36c41dec6e68f4ee2f97fe4a273b8fe;p=vlc diff --git a/doc/skins/skins2-howto.xml b/doc/skins/skins2-howto.xml index fb79f340a4..1ce25af3c2 100644 --- a/doc/skins/skins2-howto.xml +++ b/doc/skins/skins2-howto.xml @@ -101,7 +101,7 @@ difficulty to understand how VLC skins work. XML is a markup language, like HTML. It won't be explained here any further, please use Google if you don't know what XML is. You'll see, it is rather easy to understand. -The XML file used for the VLC skins follows a predefined DTD. You can find this DTD in VLC SVN, and its reading is strongly advised, since it contains the default values used for the parameters. A skin that does not follow the DTD with which VLC was compiled won't be loaded by VLC (and it might even crash it...). +The XML file used for the VLC skins follows a predefined DTD. You can find this DTD in VLC SVN, and its reading is strongly advised, since it contains the default values used for the parameters. A skin that does not follow the DTD with which VLC was compiled won't be loaded by VLC (and it might even crash it...). For a better undestanding of what follows, you should have a look at the DTD and/or at an example of valid XML skin. @@ -238,7 +238,7 @@ difficulty to understand how VLC skins work. Font - Declares a font to be used in a Text or Playlist. + Declares a font to be used in a Text or Playtree. id Identifiant of the font that will be used with controls. @@ -395,7 +395,7 @@ difficulty to understand how VLC skins work. Attributes common to all the controls - The following attributes are common to all the controls (Image, Button, Checkbox, Text, Slider, RadialSlider, Playlist, Video) + The following attributes are common to all the controls (Image, Button, Checkbox, Text, Slider, RadialSlider, Playtree, Video) id Identifiant of the control. Currently unused. @@ -577,7 +577,7 @@ difficulty to understand how VLC skins work. scrolling - Scrolling behaviour of the text (only when it doesn't fit in the width of the control). Possible values are 'auto', 'manual' and 'none'. If this attribute is set to 'auto', the text automatically starts scrolling. The user can drag the text, and click on it to start/stop the scrolling. If this attribute is set to 'manual', the text only scrolls when dragged by the user. If this attribute is set to 'none', no scrolling is possible at all. Available since VLC 0.8.5. + Scrolling behaviour of the text (only when it doesn't fit in the width of the control). Possible values are 'auto', 'autooff', 'manual' and 'none'. If this attribute is set to 'auto', the text automatically starts scrolling. The user can drag the text, and click on it to start/stop the scrolling. If this attribute is set to 'manual', the text only scrolls when dragged by the user. If this attribute is set to 'none', no scrolling is possible at all. Available since VLC 0.8.5. Default value: auto @@ -613,7 +613,7 @@ difficulty to understand how VLC skins work. value - Variable controlled by the slider. This must be a percentage variable, e.g "volume" or "time" (only exception: the Slider defined inside the Playlist tag does not need to set this attribute). + Variable controlled by the slider. This must be a percentage variable, e.g "volume" or "time" (only exception: the Slider defined inside the Playtree tag does not need to set this attribute). Default value: none @@ -681,7 +681,12 @@ difficulty to understand how VLC skins work. - Playlist + Playlist + This tag used to create a playlist. This tag is deprecated, you should now use Playtree + + + + Playtree Create a playlist. This tag must contain a Slider tag (to allow scrolling in the playlist). See the common attributes. @@ -734,6 +739,24 @@ difficulty to understand how VLC skins work. Background color for even playlist items. This attribute is ignored if the bgimage one is used. Default value: #FFFFFF + + flat + Boolean to indicate whether the playlist should use the tree structure or be completely "flat" (only show the leafs of the tree). + A flat playtree will work like old-style playlists. + Default value: false + + + itemimage + Identifiant of a Bitmap shown to the left of a leaf (playlist item). + + + openimage + Identifiant of a Bitmap shown to the left of a node, when it is expanded. + + + closedimage + Identifiant of a Bitmap shown to the left of a node, when it is retracted. + @@ -754,13 +777,13 @@ difficulty to understand how VLC skins work. dialogs.fileSimple(): Show the simple "Open File" dialog box. - dialog.file(): Show the "Open File" dialog box, with many options (stream output, subtitles, etc...). + dialogs.file(): Show the "Open File" dialog box, with many options (stream output, subtitles, etc...). - dialog.directory(): Show the "Open Directory" dialog box (new after VLC 0.8.2). + dialogs.directory(): Show the "Open Directory" dialog box (new after VLC 0.8.2). - dialog.disc(): Show the "Open Disc" dialog box. + dialogs.disc(): Show the "Open Disc" dialog box. dialogs.net(): Show the "Open Network Stream" dialog box. @@ -774,11 +797,23 @@ difficulty to understand how VLC skins work. dialogs.fileInfo(): Show the "File Info" dialog box. + + dialogs.playlist(): Show the "standard" (not skinned) playlist dialog. + dialogs.streamingWizard(): Show the "Streaming Wizard" dialog box (new after VLC 0.8.2). - dialogs.popup(): Show the popup menu, (already available with a right-click on a Image control). + dialogs.popup(): Show the full popup menu, (already available with a right-click on a Image control). + + + dialogs.audioPopup(): Show the audio settings popup menu (since VLC 0.8.5). + + + dialogs.videoPopup(): Show the video settings popup menu (since VLC 0.8.5). + + + dialogs.miscPopup(): Show a popup menu containing playback control and general options (since VLC 0.8.5). equalizer.enable(): Enable the equalizer audio filter (since VLC 0.8.5). @@ -813,6 +848,9 @@ difficulty to understand how VLC skins work. vlc.fullscreen(): Toggle the fullscreen mode. + + vlc.snapshot(): Take a snapshot (since VLC 0.8.5). + vlc.onTop(): Toggle the "Always on top" status (since VLC 0.8.0). @@ -861,6 +899,21 @@ difficulty to understand how VLC skins work. playlist.save(): Save the current playlist (since VLC 0.8.0). + + dvd.nextTitle(): Go to the next title of the DVD (since VLC 0.8.5). + + + dvd.previousTitle(): Go to the previous title of the DVD (since VLC 0.8.5). + + + dvd.nextChapter(): Go to the next chapter of the DVD (since VLC 0.8.5). + + + dvd.previousTitle(): Go to the previous chapter of the DVD (since VLC 0.8.5). + + + dvd.rootMenu(): Go to the root menu of the DVD (since VLC 0.8.5). + WindowID.show(): Show the Window whose id attribute is 'WindowID'. @@ -882,6 +935,9 @@ difficulty to understand how VLC skins work. When specifying the text attribute of the Text control or any tooltip attribute, you can insert escape sequences which will be expanded dynamically. An escape sequence always starts with the '$' character, followed by one or more predefined letters. Here is the list of accepted escape sequences: + + $B: Get the audio stream bitrate (in kb/s). + $V: Value of the volume (from 0 to 100 --> useful for a percentage). @@ -907,6 +963,9 @@ difficulty to understand how VLC skins work. $F: Full name (with path) of the stream that is being played. + + $S: Get the audio sample rate (in kHz). + Example of tooltiptext value for a slider controlling the volume: "Volume: $V%". @@ -924,6 +983,15 @@ difficulty to understand how VLC skins work. equalizer.isEnabled: True if the equalizer audio filter is enabled (since VLC 0.8.5). + + vlc.hasVout: True if a video is being played (since VLC 0.8.5). + + + vlc.hasAudio: True if audio is being played (since VLC 0.8.5). + + + vlc.isFullscreen: True when the video is in fullscreen mode (since VLC 0.8.5). + vlc.isPlaying: True when VLC is playing, false otherwise. @@ -951,6 +1019,9 @@ difficulty to understand how VLC skins work. playlist.isRepeat: True when the current playlist item is being repeated, false otherwise (since VLC 0.8.0). + + dvd.isActive: True when a DVD is currently playing. This variable can be used to display buttons associated to the dvd.* actions only when needed (since VLC 0.8.5). + window_name.isVisible: True when the window whose id is "window_name" is visible, false otherwise.