dragonleo/NSIS
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated docs

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1248 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
rainwater 2002-10-01 13:53:23 +00:00
parent c7a681751a
commit a3676511e6
24 changed files with 673 additions and 676 deletions
Download patch file Download diff file Expand all files Collapse all files

82
Docs/src/misc.but
View file

@ -1,67 +1,67 @@
\H{miscinst} Miscellaneous Instructions
\C{miscinst} Miscellaneous Instructions
\S{SetDetailsView} SetDetailsView
SetDetailsView \e{show|hide}
Shows or hides the details, depending on which parameter you pass. Overrides the default details view, which is set via ShowInstDetails
\S{SetDetailsPrint} SetDetailsPrint
SetDetailsPrint \e{none | listonly | textonly |both}
Sets mode at which commands print their status. None has commands be quiet, listonly has status text only added to the listbox, textonly has status text only printed to the status bar, and both enables both (the default). For extracting many small files, textonly is recommended (especially on win9x with smooth scrolling enabled).
\S{SetAutoClose} SetAutoClose
SetAutoClose \e{true|false}
Overrides the default auto window-closing flag (specified for the installer using AutoCloseWindow, and false for the uninstaller). Specify 'true' to have the install window immediately disappear after the install has completed, or 'false' to make it require a manual close.
\S{DetailPrint} DetailPrint
DetailPrint \e{user_message}
Adds the string "user_message" to the details view of the installer.
\S{Sleep} Sleep
Sleep \e{sleeptime_in_ms}
Pauses execution in the installer for sleeptime_in_ms milliseconds. sleeptime_in_ms can be a variable, i.e. "$0" or a number, i.e. "666".
\S{BringToFront} BringToFront
\H{BringToFront} BringToFront
BringToFront
Makes the installer window visible and brings it to the top of the window list (i.e. if a command was executed that shows itself in front of the installer, a BringToFront would bring the installer back in focus).
\S{HideWindow} HideWindow
\H{CreateFont} CreateFont
CreateFont \e{user_var(handle output) face_name [height] [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]}
Creates a font and puts its handle into user_var. For more information about the different parameters have a look at MSDN's page about the Win32 API function CreateFont().
\H{DetailPrint} DetailPrint
DetailPrint \e{user_message}
Adds the string "user_message" to the details view of the installer.
\H{HideWindow} HideWindow
HideWindow
Hides the installer.
\S{SetBrandingImage} SetBrandingImage
\H{SetAutoClose} SetAutoClose
SetAutoClose \e{true|false}
Overrides the default auto window-closing flag (specified for the installer using AutoCloseWindow, and false for the uninstaller). Specify 'true' to have the install window immediately disappear after the install has completed, or 'false' to make it require a manual close.
\H{SetBrandingImage} SetBrandingImage
SetBrandingImage \e{[/IMGID=item_id_in_dialog] [/RESIZETOFIT] path_to_bitmap_file.bmp}
Sets the current bitmap file displayed as the branding image. If no IMGID is specified, the first image control found will be used, or the image control created by AddBrandingImage. Note that this bitmap must be present on the user's machine. Use File first to put it there. If /RESIZETOFIT is specified the image will be automatically resized (very poorly) to the image control size. If you used AddBrandingImage you can get this size, by compiling your script and watching for AddBrandingImage output, it will tell you the size. SetBrandingImage will not work when called from .onInit!
\S{SetStaticBkColor} SetStaticBkColor
\H{SetDetailsView} SetDetailsView
SetStaticBkColor \e{hwnd color}
SetDetailsView \e{show|hide}
Sets a background color for a static control. Use GetDlgItem to get the handle (HWND) of the static control.
Shows or hides the details, depending on which parameter you pass. Overrides the default details view, which is set via ShowInstDetails
\S{SetShellVarContext} SetShellVarContext
\H{SetDetailsPrint} SetDetailsPrint
SetDetailsPrint \e{none | listonly | textonly |both}
Sets mode at which commands print their status. None has commands be quiet, listonly has status text only added to the listbox, textonly has status text only printed to the status bar, and both enables both (the default). For extracting many small files, textonly is recommended (especially on win9x with smooth scrolling enabled).
\H{SetShellVarContext} SetShellVarContext
SetShellVarContext \e{current|all}
Sets the context of $SMPROGRAMS and other shell folders. If set to 'current' (the default), the current user's shell folders are used. If set to 'all', the 'all users' shell folder is used. The all users folder may not be supported on all OSes. If the all users folder is not found, the current user folder will be used.
\S{CreateFont} CreateFont
\H{SetStaticBkColor} SetStaticBkColor
CreateFont \e{user_var(handle output) face_name [height] [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]}
SetStaticBkColor \e{hwnd color}
Creates a font and puts its handle into user_var. For more information about the different parameters have a look at MSDN's page about the Win32 API function CreateFont().
Sets a background color for a static control. Use GetDlgItem to get the handle (HWND) of the static control.
\H{Sleep} Sleep
Sleep \e{sleeptime_in_ms}
Pauses execution in the installer for sleeptime_in_ms milliseconds. sleeptime_in_ms can be a variable, i.e. "$0" or a number, i.e. "666".