EBanner plug-in: Difference between revisions
From NSIS Wiki
Jump to navigationJump to search
No edit summary |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 10: | Line 10: | ||
== Description == | == Description == | ||
EBanner.dll is NSIS plug-in, displaying banner on the installer page. Not stops installer execution when banner is displayed. Banner is not clickable and it's is place limited with page bottom. BMP, JPEG, GIF, PNG (with transparency) are supported. Also can play music at the same time. | EBanner.dll is NSIS plug-in, displaying banner on the installer page. Not stops installer execution when banner is displayed. Banner is not | ||
clickable and it's is place limited with page bottom. BMP, JPEG, GIF, PNG (with transparency) are supported. Also can play music at the same time. | |||
== Command line (NSIS script) == | == Command line (NSIS script) == | ||
| Line 18: | Line 20: | ||
=== show DLL Function === | === show DLL Function === | ||
ebanner::show /NOUNLOAD [/ | ebanner::show /NOUNLOAD [/HALIGN=LEFT|RIGHT|CENTER] [/VALIGN=TOP|BOTTOM|CENTER] [/HWND=xxx] [/FIT=WIDTH|HEIGHT|BOTH] FileName | ||
; /HALIGN | |||
: image horizontal alignment, default (no parameter) is center. | |||
; /VALIGN | |||
: image vertical alignment, default (no parameter) is bottom. | |||
; /FIT | |||
: image stretch direction, default (no parameter) is original size. | |||
; / | ; /HWND | ||
: | : target window, default (no parameter) is "#32770" child of $HWNDPARENT . | ||
; FileName | ; FileName | ||
: Image file name. Empty Filename string "" | : Image file name. Empty Filename string "" clears image but not stops sound playing. | ||
=== play DLL Function === | === play DLL Function === | ||
| Line 36: | Line 47: | ||
: Sound filename to play (with extension, wav, mp3 ...). Empty Filename string "" stops sound. | : Sound filename to play (with extension, wav, mp3 ...). Empty Filename string "" stops sound. | ||
=== stop DLL Function === | |||
ebanner::stop | |||
: Destroys image, clears window, stops sound (if any). Optional, on the page close auto-stop should work (I guess). | |||
== Examples == | == Examples == | ||
| Line 46: | Line 63: | ||
File catch.gif | File catch.gif | ||
ebanner::play /NOUNLOAD /LOOP '$PLUGINSDIR\snd.mp3' | ebanner::play /NOUNLOAD /LOOP '$PLUGINSDIR\snd.mp3' | ||
ebanner::show /NOUNLOAD / | ebanner::show /NOUNLOAD /HALIGN=LEFT '$PLUGINSDIR\catch.gif' | ||
; Add your page code here | ; Add your page code here | ||
ebanner::stop | ebanner::stop | ||
Latest revision as of 11:08, 19 February 2006
| Author: Takhir (talk, contrib) |
Links
Download:
EBanner.zip (32 KB)
Description
EBanner.dll is NSIS plug-in, displaying banner on the installer page. Not stops installer execution when banner is displayed. Banner is not
clickable and it's is place limited with page bottom. BMP, JPEG, GIF, PNG (with transparency) are supported. Also can play music at the same time.
Command line (NSIS script)
Plug-in DLL functions (entry points): show, play, stop
show DLL Function
ebanner::show /NOUNLOAD [/HALIGN=LEFT|RIGHT|CENTER] [/VALIGN=TOP|BOTTOM|CENTER] [/HWND=xxx] [/FIT=WIDTH|HEIGHT|BOTH] FileName
- /HALIGN
- image horizontal alignment, default (no parameter) is center.
- /VALIGN
- image vertical alignment, default (no parameter) is bottom.
- /FIT
- image stretch direction, default (no parameter) is original size.
- /HWND
- target window, default (no parameter) is "#32770" child of $HWNDPARENT .
- FileName
- Image file name. Empty Filename string "" clears image but not stops sound playing.
play DLL Function
ebanner::play /NOUNLOAD [/LOOP] FileName
- /LOOP
- Sets 'repeat' flag for hidden MCI player.
- FileName
- Sound filename to play (with extension, wav, mp3 ...). Empty Filename string "" stops sound.
stop DLL Function
ebanner::stop
- Destroys image, clears window, stops sound (if any). Optional, on the page close auto-stop should work (I guess).
Examples
Package includes nsi script sample.
SetOutPath '$PLUGINSDIR' File snd.mp3 File catch.gif ebanner::play /NOUNLOAD /LOOP '$PLUGINSDIR\snd.mp3' ebanner::show /NOUNLOAD /HALIGN=LEFT '$PLUGINSDIR\catch.gif' ; Add your page code here ebanner::stop Delete '$PLUGINSDIR\snd.mp3' Delete '$PLUGINSDIR\catch.gif'
