NsisSlideshow plug-in

From NSIS Wiki
Jump to navigationJump to search
Author: Wizou (talk, contrib)


Links

nsisSlideshow Plugin Homepage

Presentation

nsisSlideshow is a small NSIS plugin that can display fading banners/slideshow.

Features:

  • Can be used inside NSIS window or on any other window (HWND) created by NSIS
  • Manual (synchronized) or Automatic mode (slideshow runs in background while NSIS script continues)
  • You can add subtitles to your slides
  • Supports Unicode NSIS
  • Run-once or cycle to beginning at end of slideshow

KNOWN ISSUE:

 NOT WORK UNDER WIN7+IE 9 , See [ http://wiz0u.free.fr/forum/viewtopic.php?f=11&t=580 sisSlideshow Plugin Forums]


Usage

The following is taken from the readme file in the downloadable zip file:

nsisSlideshow::show /NOUNLOAD [options] <picture filename>				(Manual mode)
nsisSlideshow::show /NOUNLOAD [options] /auto=<control file>			(Automatic mode)

options can be:
/HWND=<handle value>			use the bounds rectangle of the given window to draw the banner
								(by default, the banner occupies the area of the details listview)
/FIT=HEIGHT|WIDTH|BOTH|STRETCH	reduce/enlarge the picture(s) to fit the given constraint inside the rectangle
								(default: BOTH)
/HALIGN=LEFT|CENTER|RIGHT		horizontal placement within the rectangle (default:
CENTER)
/VALIGN=TOP|CENTER|BOTTOM		vertical placement within the rectangle (default: CENTER)
/CCOLOR=0xBBGGRR				blue/green/red hexadecimal value for the color of the optional subtitle (default: white)
								(make sure the color of the bottom part of the picture allows for readability of the subtitle)

options in manual mode can also be:
/DURATION=<delay in ms>			fade-in duration to display the picture (default: 1000 ms)
"/CAPTION=<string>"				add the given subtitle string in the bottom of the picture (use quotes if there are spaces)

pictures format can be JPEG, PNG, GIF, BMP, WMF

automatic control file is a text file that defines the pictures to display in the slideshow, depending on the current language.
Format of definition groups:
[<language value>]			; Locale ID decimal value. See http://msdn.microsoft.com/en-us/library/0h88fahh%28VS.85%29.aspx
=<picture filename>,<fadein delay>,<tempo delay>[,<subtitle caption>]
=<picture filename>,<fadein delay>,<tempo delay>[,<subtitle caption>]
=<picture filename>,<fadein delay>,<tempo delay>[,<subtitle caption>]
...
The pictures should preferably be in the same directory as the control file. (you will typically extract the slideshow folder to $PLUGINSDIR)
Delay are in ms. Tempo delay is the time to wait before switching to the next picture.
Subtitle caption must be encoded in the adequate language codepage (like NSIS language strings)

If the group ends with a line containing only a period (.), the slideshow will stop at the last picture.
Otherwise, the slideshow will cycle back to the first picture.

You can put several language groups in the control file, and change the picture/captions/etc... according to the language.
If the current language is not found, it will default to group [1033] (english), and if not found to group [0].


nsisSlideshow::stop

Call this to abort or terminate the display of banner(s) when the installation ends
This will also release memory used by the plugin and unload the DLL


Download

nsisSlideshow Plugin Homepage

ZIP archive contains the plug-in DLLs (ANSI & Unicode NSIS) as well as documentation, source code and sample script