cleared up some InstType indexing confusion

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@3607 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik 2004-08-07 10:14:23 +00:00
parent b09c7fe4e9
commit e6c31f04ed
3 changed files with 6 additions and 6 deletions

View file

@ -184,7 +184,7 @@ Valid values for flag are "smooth" (smooth the progress bar) or "colored" (color
\c install_type_name | /NOCUSTOM | /CUSTOMSTRING=str | /COMPONENTSONLYONCUSTOM
Adds an install type to the install type list, or disables the custom install type. There can be as many as 32 types, each one specifying the name of the install type. If the name is prefixed with 'un.' it is an uninstaller install type. Instead of an "hard-coded" name you can use user variables which are processed at runtime. This allows you to change InstType name dynamically. Another way of changing the InstType name during runtime is the \R{sinsttypesettext}{InstTypeSetText} command. The difference is that with InstTypeSetText you are saving your precious user variables. The first type is the default (generally 'Typical'). Each type is numbered, starting at 1. See SectionIn for information on how those numbers are used. If the /NOCUSTOM switch is specified, then the "custom" install type is disabled, and the user has to choose one of the pre-defined install types. Alternatively, if the /CUSTOMSTRING switch is specified, the parameter will override the "Custom" install type text. Alternatively, if the /COMPONENTSONLYONCUSTOM flag is specified, the component list will only be show
Adds an install type to the install type list, or disables the custom install type. There can be as many as 32 types, each one specifying the name of the install type. If the name is prefixed with 'un.' it is an uninstaller install type. Instead of an "hard-coded" name you can use user variables which are processed at runtime. This allows you to change InstType name dynamically. Another way of changing the InstType name during runtime is the \R{sinsttypesettext}{InstTypeSetText} command. The difference is that with \R{sinsttypesettext}{InstTypeSetText} you are saving your precious user variables. The first type is the default (generally 'Typical'). If the /NOCUSTOM switch is specified, then the "custom" install type is disabled, and the user has to choose one of the pre-defined install types. Alternatively, if the /CUSTOMSTRING switch is specified, the parameter will override the "Custom" install type text. Alternatively, if the /COMPONENTSONLYONCUSTOM flag is specified, the component list will only be show
n if the "Custom" install type is selected.
\S2{alicensebkcolor} LicenseBkColor

View file

@ -58,21 +58,21 @@ Gets the Size of the section specified by section_index and stores the value in
\c inst_type_idx
Sets the current InstType. The Error Flag is \\<b\\>not\\</b\\> set if an out of range InstType was used.
Sets the current InstType. inst_type_idx should be between 0 and 31. The Error Flag is \\<b\\>not\\</b\\> set if an out of range InstType was used.
SetCurInstType currently only works when the there is a components page.
SetCurInstType currently only works when the components page is active (\R{pagecallbacks_explain}{show function}, \R{pagecallbacks_explain}{leave function}, \R{onselchange}{.onSelChange} and \R{onmouseoversection}{.onMouseOverSection}).
\S2{sgetcurinsttype} GetCurInstType
\c user_var
Get the current InstType and stores the Value in the given User Variable. The value of $\{NSIS_MAX_INST_TYPES\} (32 by default) means that the custom installation type was selected.
Get the current InstType and stores it in user_var. If the first install type is selected, 0 will be put in user_var. If the second install type is selected, 1 will be put in user_var, and so on. The value of $\{NSIS_MAX_INST_TYPES\} (32 by default) means that the custom install type was selected.
\S2{sinsttypesettext} InstTypeSetText
\c inst_type_idx text
Sets the Text of the specified InstType. If the Text is empty than the InstType is removed. By using a previously unused inst_type_idx number you can create new InstTypes. To add/remove Sections to this new InstType see \R{sectionsetinsttypes}{SectionSetInstTypes}. Unlike \R{ssectionin}{SectionIn} the index is zero based, which means the first installation type's index is 0.
Sets the Text of the specified InstType. If the Text is empty than the InstType is removed. By using a previously unused inst_type_idx number you can create new InstTypes. To add/remove Sections to this new InstType see \R{sectionsetinsttypes}{SectionSetInstTypes}. Unlike \R{ssectionin}{SectionIn} the index is zero based, which means the first install type's index is 0.
\S2{sinsttypegettext} InstTypeGetText

View file

@ -30,7 +30,7 @@ This command closes the current open section.
\c insttype_index [insttype_index] [RO]
This command specifies which install types (see \R{ainsttype}{InstType}) the current section defaults to the enabled state in. Multiple SectionIn commands can be specified (they are combined). If you specify RO as a parameter, then the section will be read-only, meaning the user won't be able to change its state.
This command specifies which install types (see \R{ainsttype}{InstType}) the current section defaults to the enabled state in. Multiple SectionIn commands can be specified (they are combined). If you specify RO as a parameter, then the section will be read-only, meaning the user won't be able to change its state. The first install type defined using \R{ainsttype}{InstType} is indexed 1, the next 2 and so on.
\S2{ssubsection} SubSection