Updated docs

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1609 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
rainwater 2002-11-06 21:20:55 +00:00
parent 9e16ba98b8
commit 90ea8491f4
22 changed files with 246 additions and 243 deletions

View file

@ -1,62 +1,12 @@
\C{miscinst} Miscellaneous Instructions
\H{miscinst} Miscellaneous Instructions
\H{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).
\H{createfont} CreateFont
\c 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 \W{http://msdn.microsoft.com/library/default.asp?url=/library/en-us/gdi/fontext_8fp0.asp}{MSDN's page about the Win32 API function CreateFont()}.
\H{detailprint} DetailPrint
\c user_message
Adds the string "user_message" to the details view of the installer.
\H{hidewindow} HideWindow
Hides the installer.
\H{setautoclose} SetAutoClose
\c 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
\c [/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!
\H{setdetailsview} SetDetailsView
\c show|hide
Shows or hides the details, depending on which parameter you pass. Overrides the default details view, which is set via ShowInstDetails
\H{setdetailsprint} SetDetailsPrint
\c none|listonly|textonly|both|lastused
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
\S{setshellvarcontext} SetShellVarContext
\c 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.
\H{setstaticbkcolor} SetStaticBkColor
\c hwnd color
Sets a background color for a static control. Use GetDlgItem to get the handle (HWND) of the static control.
\H{sleep} Sleep
\S{sleep} Sleep
\c sleeptime_in_ms