AnimGif plug-in: Difference between revisions

From NSIS Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 18: Line 18:
=== play DLL Function ===
=== play DLL Function ===


  AnimGif::play /NOUNLOAD [/ALIGN={LEFT|RIGHT|CENTER}] [/HWND=xxx] [/FIT=WIDTH|HEIGHT] [/BGCOL=xxx] FileName
  AnimGif::play /NOUNLOAD [/HALIGN=LEFT|RIGHT|CENTER] [/VALIGN=TOP|BOTTOM|CENTER] [/HWND=xxx] [/FIT=WIDTH|HEIGHT|BOTH] [/BGCOL=xxx] FileName


; /ALIGN
; /HALIGN
: Changes horizontal alignment for the image, default (no parameter) is center.
: image horizontal alignment, default (no parameter) is center.
 
; /VALIGN
: image vertical alignment, default (no parameter) is bottom.


; /HWND
; /HWND
: Sets target window. Default is current page '#32770' class child.
: target window, default (no parameter) is "#32770" child of $HWNDPARENT .
 


; /BGCOL
; /BGCOL
: Color to use for image trasparent areas. If not defined, plug-in attempts to extract value from target window, but this is not possible if window is hidden. Color value may be hex (starting with 0x) and decimal (first is not 0). Hex value will be used as RGB color, decimal - as Windows system color index in GetSysColor() API call, see MSDN. If value not specified and target window stays hidden (for example in custom 'Show' function), default COLOR_BTNFACE will be used.
: color to use for image trasparent areas. If not defined, plug-in attempts to extract value from target window, but this is not possible if window is hidden. Color value may be hex (starting with 0x) and decimal (first is not 0). Hex value will be used as RGB color, decimal - as Windows system color index in GetSysColor() API call, see MSDN. If value not specified and target window stays hidden (for example in custom 'Show' function), default COLOR_BTNFACE will be used.


; /FIT
; /FIT
: Image stretch to occupy window width or height. For Welcome page left logo and screen dpi 120 mainly. Default - no stretch.
: image stretch to occupy window width or height. For Welcome page left logo and screen dpi 120 mainly. Default - no stretch.


; FileName
; FileName
Line 53: Line 57:
AnimGif::stop
AnimGif::stop
Delete '$PLUGINSDIR\sample.gif'
Delete '$PLUGINSDIR\sample.gif'
Delete '$PLUGINSDIR\AnimGif.dll'
</highlight-nsis>
</highlight-nsis>


[[Category:Plugins]]
[[Category:Plugins]]

Revision as of 11:22, 19 February 2006

Author: Takhir (talk, contrib)


Links

Download:
AnimGif.zip (45 KB)

Forum thread

Description

AnimGif.dll is NSIS plug-in, displaying animated 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 (window) bottom. May be used in the page custom show/leave functions and on other (not page) windows with possible trasparency limitations.

Command line (NSIS script)

Plug-in DLL functions (entry points): play, stop

play DLL Function

AnimGif::play /NOUNLOAD [/HALIGN=LEFT|RIGHT|CENTER] [/VALIGN=TOP|BOTTOM|CENTER] [/HWND=xxx] [/FIT=WIDTH|HEIGHT|BOTH] [/BGCOL=xxx] FileName
/HALIGN
image horizontal alignment, default (no parameter) is center.
/VALIGN
image vertical alignment, default (no parameter) is bottom.
/HWND
target window, default (no parameter) is "#32770" child of $HWNDPARENT .


/BGCOL
color to use for image trasparent areas. If not defined, plug-in attempts to extract value from target window, but this is not possible if window is hidden. Color value may be hex (starting with 0x) and decimal (first is not 0). Hex value will be used as RGB color, decimal - as Windows system color index in GetSysColor() API call, see MSDN. If value not specified and target window stays hidden (for example in custom 'Show' function), default COLOR_BTNFACE will be used.
/FIT
image stretch to occupy window width or height. For Welcome page left logo and screen dpi 120 mainly. Default - no stretch.
FileName
Image file name.

stop DLL Function

AnimGif::stop
Stops animation and cleares the screeen.


Examples

Package includes nsi script sample.

SetOutPath '$PLUGINSDIR'
File sample.gif
AnimGif::play /NOUNLOAD '$PLUGINSDIR\sample.gif'
; Add your page code here
AnimGif::stop
Delete '$PLUGINSDIR\sample.gif'