Modern UI 1.66: support for uninst comp page, multiple pages, new language & page system

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@2824 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
joostverburg 2003-09-04 18:42:21 +00:00
parent 74ea2dc585
commit 9ee58d14f8
11 changed files with 926 additions and 991 deletions

View file

@ -1,5 +1,12 @@
NSIS Modern User Interface - VERSION HISTORY
1.66 - September 4, 2003
* New system for page settings and custom pages
* Support for uninstaller components page
* Support for multiple pages of the same type
* Changed macro names
* Updated langauge system, new language files
1.65 - July 16, 2003
* New page configuration system, no different system for installers
with custom pages
@ -21,11 +28,11 @@ NSIS Modern User Interface - VERSION HISTORY
1.64 - April 27, 2003
* Support for license page with checkbox or radiobuttons to let the
user accept the agreement or not
* Macro's for finish headers don't have to be inserted anymore
* Macros for finish headers don't have to be inserted anymore
* Language preference stored when installation has completed,
no problems anymore when the users selects the wrong language
* Header text for aborted installation
* New macro's: get language for uninstaller, delete shortcuts
* New macros: get language for uninstaller, delete shortcuts
* Language specific fonts
* Welcome/Finish page INI files can be modified in pre functions
* More texts can be customized
@ -40,7 +47,7 @@ NSIS Modern User Interface - VERSION HISTORY
* Easier to customize resource files
* New system for custom functions
* Start Menu folder registry key automatically written
* New InstallOptions macro's that do not remove the return value from
* New InstallOptions macros that do not remove the return value from
the stack
* Support for custom pages before the finish page
* Renamed Start Menu page defines
@ -52,7 +59,6 @@ NSIS Modern User Interface - VERSION HISTORY
* No changed language strings
1.62 - February 2, 2003
* Final version for NSIS 2 beta 1
* New language strings for finish page
* Possibility to let a Modern UI Function call your own function
* No problems anymore when using both 'Run program' and 'Show Readme'
@ -60,7 +66,7 @@ NSIS Modern User Interface - VERSION HISTORY
* Default state of checkboxes on the finish page can be changed
* Welcome / Finish page compatible with custom DPI settings
* Converted Install Options INI files to use dialog units
* More ReserveFile macro's
* More ReserveFile macros
* Background color can be changed with a define
* Support for multilingual branding texts
* Start Menu / Finish page window titles also work when using
@ -71,7 +77,6 @@ NSIS Modern User Interface - VERSION HISTORY
the verbose settings during compilation
1.61 - December 5, 2002
* Final version for NSIS 2 beta 0
* modern3.exe UI without description area
* Added define to show uninstall confirm page
* Added language string for finish page title and continue to uninstall
@ -92,14 +97,14 @@ NSIS Modern User Interface - VERSION HISTORY
* Start Menu Folder selection page
* 'Click Next to continue' and 'Click Install to start the installation'
texts automatically change to the page order
* Install Options macro's updated. MUI_INSTALLOPTIONS_DISPLAY is the
* Install Options macros updated. MUI_INSTALLOPTIONS_DISPLAY is the
standard macro now.
Use MUI_INSTALLOPTIONS_INITDIALOG and MUI_INSTALLOPTIONS_SHOW if you
want to customize dialog controls.
* No more writing window titles & abort warnings to Install Options
INI Files
* Compatible with updated paging system
* Renamed macro's and defines
* Renamed macros and defines
* Some small fixes
1.4 - November 4, 2002
@ -107,7 +112,7 @@ NSIS Modern User Interface - VERSION HISTORY
* Macro System updates (smaller)
* Macro System a lot easier
* Modern UI Language Files load NLF language files
* Renamed macro's and defines
* Renamed macros and defines
1.3 - October 27, 2002
* Easier macro system for basic scripts
@ -115,16 +120,16 @@ NSIS Modern User Interface - VERSION HISTORY
* New directory structure (header/language files in Contrib\Modern UI)
* Small bugfixes & typo corrections
* SetPage function should be set using defines
* Different NextPage/PrevPage/FinishHeader macro's for
* Different NextPage/PrevPage/FinishHeader macros for
install/uninstall
* Interface settings can be definend (for example, MUI_ICON), no
parameters for MUI_INTERFACE anymore
* New Install Options macro's to read/write IO INI file value
* New Install Options macros to read/write IO INI file value
1.21 - September 30, 2002
* Temp vars set in Modern UI header
* Currentpage & Install Options vars should be set using
parameters of the MUI_INTERFACE and * MUI_INSTALLOPTIONS macro's
parameters of the MUI_INTERFACE and * MUI_INSTALLOPTIONS macros
* MultiLanguage.nsi uses the new language strings
1.2 - September 22, 2002
@ -138,8 +143,8 @@ NSIS Modern User Interface - VERSION HISTORY
* Examples use ReserveFile for faster startup
1.19 - Semtember 19, 2002
* Renamed some macro's
* Custom code can be used between page start/stop macro's
* Renamed some macros
* Custom code can be used between page start/stop macros
1.18 - Semtember 13, 2002
* Uses the new Sendmessage string option
@ -170,7 +175,7 @@ NSIS Modern User Interface - VERSION HISTORY
1.1 - August 29, 2002
* Header file with macros, it's now very easy to use the UI in your
scripts :)
scripts
* Added the modern2.exe UI, with an other location of the Description
frame, for installers with a lot of subsections (thanks rainwater)
* Updated example scripts

View file

@ -1,5 +1,5 @@
;NSIS Modern User Interface - Language File
;Compatible with Modern UI 1.65
;Compatible with Modern UI 1.66
;Language: English (1033)
;By Joost Verburg
@ -22,19 +22,16 @@
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_LICENSE_SUBTITLE "Please review the license terms before installing ${MUI_PRODUCT}."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_LICENSE_TOP "Press Page Down to see the rest of the agreement."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_LICENSE_BOTTOM "If you accept the terms of the agreement, click I Agree to continue. You must accept the agreement to install ${MUI_PRODUCT}."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_LICENSE_BOTTOM_CHECKBOX "If you accept the terms of the agreement, click the check box below. You must accept the agreement to install ${MUI_PRODUCT}."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_LICENSE_BOTTOM_RADIOBUTTONS "If you accept the terms of the agreement, select the first option below. You must accept the agreement to install ${MUI_PRODUCT}."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_LICENSE_BOTTOM_CHECKBOX "If you accept the terms of the agreement, click the check box below. You must accept the agreement to install ${MUI_PRODUCT}. $_CLICK"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_LICENSE_BOTTOM_RADIOBUTTONS "If you accept the terms of the agreement, select the first option below. You must accept the agreement to install ${MUI_PRODUCT}. $_CLICK"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_COMPONENTS_TITLE "Choose Components"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_COMPONENTS_SUBTITLE "Choose which features of ${MUI_PRODUCT} you want to install."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_COMPONENTS_TOP "Check the components you want to install and uncheck the components you don't want to install."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_COMPONENTS_DESCRIPTION_TITLE "Description"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_COMPONENTS_DESCRIPTION_INFO "Hover your mouse over a component to see its description."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_DIRECTORY_TITLE "Choose Install Location"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_DIRECTORY_SUBTITLE "Choose the folder in which to install ${MUI_PRODUCT}."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_DIRECTORY_TOP "Setup will install ${MUI_PRODUCT} in the following folder.$\r$\n$\r$\nTo install in a different folder, click Browse and select another folder."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_INNERTEXT_DIRECTORY_DESTINATION "Destination Folder"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_INSTALLING_TITLE "Installing"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_INSTALLING_SUBTITLE "Please wait while ${MUI_PRODUCT} is being installed."
@ -45,7 +42,7 @@
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_ABORT_TITLE "Installation Aborted"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_ABORT_SUBTITLE "Setup was not completed successfully."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_FINISH_BUTTON "&Finish"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_BUTTONTEXT_FINISH "&Finish"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_FINISH_INFO_TITLE "Completing the ${MUI_PRODUCT} Setup Wizard"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_FINISH_INFO_TEXT "${MUI_PRODUCT} has been installed on your computer.\r\n\r\nClick Finish to close this wizard."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_TEXT_FINISH_INFO_REBOOT "Your computer must be restarted in order to complete the installation of ${MUI_PRODUCT}. Do you want to reboot now?"
@ -66,7 +63,9 @@
!insertmacro MUI_LANGUAGEFILE_STRING MUI_UNTEXT_INTRO_TITLE "Uninstall ${MUI_PRODUCT}"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_UNTEXT_INTRO_SUBTITLE "Remove ${MUI_PRODUCT} from your computer."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_UNINNERTEXT_INTRO "This wizard will uninstall ${MUI_PRODUCT} from your computer."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_UNTEXT_COMPONENTS_TITLE "Choose Components"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_UNTEXT_COMPONENTS_SUBTITLE "Choose which features of ${MUI_PRODUCT} you want to uninstall."
!insertmacro MUI_LANGUAGEFILE_STRING MUI_UNTEXT_UNINSTALLING_TITLE "Uninstalling"
!insertmacro MUI_LANGUAGEFILE_STRING MUI_UNTEXT_UNINSTALLING_SUBTITLE "Please wait while ${MUI_PRODUCT} is being uninstalled."

View file

@ -145,10 +145,24 @@ control the interface has already been written for you.</p>
an older script with the Classic UI, follow the steps below.</p>
<p class="text">Taking a look at the <a href="#examples">example</a> scripts
will also help you to learn more about the Modern UI.</p>
<p class="text"><span class="bold">Note:</span> If you want to add a
double quote (&quot;) to a Modern UI string, you should always escape
it ($\&quot;), because the Modern UI macros use &quot; to separate
parameters.</p>
<p class="subheader">Syntax</p>
<p class="text">Most defines (i.e. MUI_COMPONENTSPAGE_SMALLDESC) don't need a value, they are true/false settings.
Others (i.e. MUI_FINISHPAGE_RUN) can be used to define a specific
value.</p>
<p class="text">Parameters are specified in this format:
<span class="parameter">required (option1 | option2)
[optional]</span></p>
<p class="text">You should put all parameters in one string for the define:</p>
<pre class="margin">
!define MUI_STARTMENUPAGE_NODISABLE ;No value
!define MUI_FINISHPAGE_RUN "$INSTDIR\Application.exe" ;Value
!define MUI_INSTALLCOLORS "FFFFFF 000000" ;Multiple parameters
!define MUI_LICENSEPAGE_TEXT "$\"Text$\" $\"Buttontext$\"" ;Multiple texts
</pre>
<p class="text">If you want a certain value (i.e. a text) to be language-specific, set a language string and define
$(LANGUAGESTRINGNAME) as value.</p>
<p class="text">When adding a double quote (&quot;) to a Modern UI string, you should always escape it ($\&quot;),
because the Modern UI macros use &quot; to separate parameters.</p>
<p class="subheader">1. Include the header file</p>
<pre class="margin">!include "MUI.nsh"</pre>
<p class="text">MUI.nsh is in the Include directory, so you don't have
@ -163,14 +177,18 @@ parameters.</p>
<p class="subheader">3. Pages</p>
<p class="text">Insert the following macros to set the pages you want to use.
The pages will appear in the order you insert them in your script.
You can also insert custom Page commands between the macros to add custom pages.<br />
You can also insert custom Page commands between the macros to add custom pages.
<a href="#customPages">More info about custom pages...</a></p>
<p class="text">Example:</p>
<pre class="margin">!insertmacro MUI_PAGE_COMPONENTS</pre>
<p class="text">You can add multiple pages of certain types (for example, if you
want the user to specify multiple folders).</p>
<p class="text">Examples:</p>
<pre class="margin">
!insertmacro MUI_PAGE_LICENSE "License.rtf"
!insertmacro MUI_PAGE_COMPONENTS</pre>
<p class="text">
<span class="bold">Installer Pages</span><br />
MUI_PAGE_WELCOME<br />
MUI_PAGE_LICENSE<br />
MUI_PAGE_LICENSE <span class="parameter">text/rtf_file</span><br />
MUI_PAGE_COMPONENTS<br />
MUI_PAGE_DIRECTORY<br />
MUI_PAGE_STARTMENU<br />
@ -180,27 +198,32 @@ parameters.</p>
<p class="text">
<span class="bold">Uninstaller Pages</span><br />
MUI_UNPAGE_CONFIRM<br />
MUI_UNPAGE_COMPONENTS<br />
MUI_UNPAGE_INSTFILES<br />
</p>
<p class="subheader">4. Defines</p>
<p class="text">You can use defines to configure the Modern UI.
Most defines (i.e. MUI_COMPONENTSPAGE_SMALLDESC)
don't need a value, they are true/false settings. Others
(i.e. MUI_FINISHPAGE_RUN) can be used to define a specific
value.</p>
<p class="text">Parameters are specified in this format:
<span class="parameter">required (option1 | option2)
[optional]</span>.</p>
<p class="text">You should put all parameters in one string for the define:</p>
<pre class="margin">
!define MUI_STARTMENUPAGE_NODISABLE ;No value
!define MUI_FINISHPAGE_RUN "$INSTDIR\Application.exe" ;Value
!define MUI_INSTALLCOLORS "FFFFFF 000000" ;Multiple parameters
</pre>
<p class="text">All defines are optional.</p>
<p class="subheader">4a. General settings</p>
<p class="sub2header">Page Settings</p>
<div class="margin">
<p class="text">To configure a page, you can define the page settings before inserting a page macro.</p>
<p class="sub2header">General Page Settings</p>
<div class="margin">
<p class="text"><span class="bold">MUI_PAGE_HEADER_TEXT </span><br />
Custom text to display on the header of the page.</p>
<p class="text"><span class="bold">MUI_PAGE_HEADER_SUBTEXT </span><br />
Custom subtext to display on the header of the page.</p>
</div>
<p class="sub2header">Welcome Page Settings</p>
<div class="margin">
<p class="text"><span class="bold">MUI_WELCOMEPAGE_TITLE </span><span class="parameter">title </span><br />
Title to display on the welcome page.</p>
<p class="text"><span class="bold">MUI_WELCOMEPAGE_TEXT </span><span class="parameter">text </span><br />
Texts to display on the welcome page. Use \r\n for a newline.</p>
</div>
<p class="sub2header">License Page Settings</p>
<div class="margin">
<p class="text"><span class="bold">MUI_LICENSEPAGE_TEXT </span><span class="parameter">text [buttontext]</span><br />
Texts to display on the inner dialog of the license page. Put quotes around the different texts ($\").</p>
<p class="text"><span class="bold">MUI_LICENSEPAGE_TEXT_TOP </span><span class="parameter">text</span><br />
Text to display on the top of the inner dialog of the license page.</p>
<p class="text"><span class="bold">MUI_LICENSEPAGE_CHECKBOX</span><br />
Display a checkbox the user has to check to agree with the license terms.</p>
<p class="text"><span class="bold">MUI_LICENSEPAGE_RADIOBUTTONS</span><br />
@ -209,27 +232,33 @@ parameters.</p>
</div>
<p class="sub2header">Components Page Settings</p>
<div class="margin">
<p class="text"><span class="bold">MUI_COMPONENTSPAGE_SMALLDESC</span><br />
A small description area on the bottom of the page. Use this layout
if you have a lot of sections and don't need large descriptions.</p>
<p class="text"><span class="bold">MUI_COMPONENTSPAGE_NODESC</span><br />
No description area.</p>
<p class="text"><span class="bold">MUI_COMPONENTSPAGE_TEXT </span><span class="parameter">text [subtext] [subtext2]</span><br />
Texts to display on the inner dialog of the components page. Put quotes around the different texts ($\").</p>
</div>
<p class="sub2header">Start Menu Folder Page Settings</p>
<p class="sub2header">Directory Page Settings</p>
<div class="margin">
<p class="text">If you did not disable the 'Do not create shortcuts' checkbox,
put the script code to write the shortcuts between these macros,
because the creation can be disabled by the user:</p>
<p class="text"><span class="bold">MUI_DIRECTORYPAGE_TEXT </span><span class="parameter">text [subtext]</span><br />
Texts to display on the inner dialog of the directory page. Put quotes around the different texts ($\").</p>
<p class="text"><span class="bold">MUI_DIRECTORYPAGE_VARIABLE </span><span class="parameter">variable</span><br />
Variable in which to store the selected folder<br />
<i>Default: $INSTDIR</i></p>
</div>
<p class="sub2header">Start Menu Folder Page Settings</p>
<div class="margin">
<p class="text">Put the code to write the shortcuts (using CreateShortcut) between this macros:</p>
<pre class="margin">
!insertmacro MUI_STARTMENU_WRITE_BEGIN
...create the shortcuts...
!insertmacro MUI_STARTMENU_WRITE_END
</pre>
<p class="text">When using multiple Start Menu Folder pages, you should also undefine previous StartMenu page
defines and define the values of the page of which you want to write the value, before inserting the
MUI_STARTMENU_WRITE_BEGIN macro.</p>
<p class="text"><span class="bold">MUI_STARTMENUPAGE_VARIABLE </span><span class="parameter">variable</span><br />
Variable to store the current Start Menu Folder. Default is $MUI_STARTMENU_FOLDER.
You cannot use this variable in your script (or you should Push/Pop it).</p>
<p class="text"><span class="bold">MUI_STARTMENUPAGE_DEFAULTFOLDER </span><span class="parameter">folder</span><br />
The default Start Menu Folder. For installers with multiple languages, you can use a language string as value.</p>
The default Start Menu Folder.</p>
<p class="text"><span class="bold">MUI_STARTMENUPAGE_NODISABLE</span><br />
Do not display the checkbox to disable the creation of Start Menu
shortcuts.</p>
@ -242,9 +271,12 @@ parameters.</p>
uninstaller.</p>
<p class="text">In the uninstaller, use the MUI_STARTMENU_GETFOLDER macro to get the Start Menu folder:</p>
<pre class="margin">
!insertmacro MUI_STARTMENU_GETFOLDER $R0 ;You can also use another variable
!insertmacro MUI_STARTMENU_GETFOLDER $R0 ;You can also use another var
Delete "$SMPROGRAMS\$R0\Your Shortcut.lnk"
</pre>
<p class="text">When using multiple Start Menu Folder pages, you should also undefine previous StartMenu page
defines and define the values of the page of which you want to get the value, before inserting the
MUI_STARTMENU_GETFOLDER macro.</p>
</div>
<p class="sub2header">Finish Page Settings</p>
<div class="margin">
@ -264,8 +296,7 @@ parameters.</p>
</div>
<p class="text"><span class="bold">MUI_FINISHPAGE_SHOWREADME </span><span class="parameter">file/url</span><br />
File or website which the user can select to view using a checkbox.
You don't need to put quotes around the filename when it contains spaces.
Use $(LANGSTRINGNAME) as value if you want to use a language string.</p>
You don't need to put quotes around the filename when it contains spaces.</p>
<div class="margin">
<p class="text"><span class="bold">MUI_FINISHPAGE_SHOWREADME_NOTCHECKED</span><br />
Do not check the 'Show Readme' checkbox by default</p>
@ -275,13 +306,11 @@ parameters.</p>
use it for other things.</p>
</div>
<p class="text"><span class="bold">MUI_FINISHPAGE_LINK </span><span class="parameter">link_text</span><br />
Text for a link on the which the user can click to view a website or file.
Use $(LANGSTRINGNAME) as value if you want to use a language string.</p>
Text for a link on the which the user can click to view a website or file.</p>
<div class="margin">
<p class="text"><span class="bold">MUI_FINISHPAGE_LINK_LOCATION </span><span class="parameter">file/url</span><br />
Website or file which the user can select to view using the link.
You don't need to put quotes around the filename when it contains spaces.
Use $(LANGSTRINGNAME) as value if you want to use a language string.</p>
You don't need to put quotes around the filename when it contains spaces.</p>
</div>
<p class="text"><span class="bold">MUI_FINISHPAGE_NOAUTOCLOSE</span><br />
Do not automatically jump to the finish page, to allow the user to
@ -291,12 +320,16 @@ parameters.</p>
Define this option to save some space if you are not using the /REBOOTOK
flag or SetRebootFlag.</p>
</div>
<p class="sub2header">Other settings</p>
<p class="sub2header">Advanced Page Settings</p>
<div class="margin">
<p class="text"><span class="bold">MUI_ABORTWARNING</span><br />
Show a message box with a warning when the user wants to close the installer.</p>
<p class="text">You can add your custom code to the page functions of Modern UI pages.
<a href="#customFunctions">More info...</a></p>
</div>
<p class="subheader">4b. Interface settings</p>
</div>
<p class="subheader">4. Interface Settings</p>
<p class="text">Page interface settings apply to all pages of a certain type.</p>
<p class="sub2header">General Interface Settings</p>
<div class="margin">
<p class="text">For UI elements that are enabled by default, the default value will be used when a setting
has not been defined.</p>
<p class="text"><span class="bold">MUI_UI </span><span class="parameter">ui_file</span><br />
@ -323,8 +356,7 @@ parameters.</p>
<i>Default: ${NSISDIR}\Contrib\Icons\modern.bmp</i></p>
<p class="text"><span class="bold">MUI_INSTALLCOLORS </span><span class="parameter">(/windows |
(foreground color: RRGGBB hexadecimal) (background color: RRGGBB hexadecimal))</span><br />
The colors of the details screen. Use /windows for the default colors.<br />
<i>Default: /windows</i></p>
The colors of the details screen. Use /windows for the default colors.</p>
<p class="text"><span class="bold">MUI_PROGRESSBAR </span><span class="parameter">("" | colored | smooth)</span><br />
The style of the progress bar. Colored makes it use the MUI_INSTALLCOLORS.<br /><i>Default: smooth</i></p>
<p class="text"><span class="bold">MUI_HEADERBITMAP </span><span class="parameter">bmp_file</span><br />
@ -351,12 +383,26 @@ parameters.</p>
bitmap that fits exactly, you should not use this option because the size of the field will be different
if the user has a custom DPI setting.</p>
</div>
<p class="text"><span class="bold">MUI_BGCOLOR </span><span class="parameter">(color: 0xBBGGRR hexadecimal)</span><br />
Background color for the header, Welcome page and Finish page.<br /><i>Default: 0xFFFFFF</i></p>
<p class="text"><span class="bold">MUI_BGCOLOR </span><span class="parameter">(color: RRGGBBR hexadecimal)</span><br />
Background color for the header, Welcome- and Finish page.<br /><i>Default: FFFFFF</i></p>
<p class="text"><span class="bold">MUI_FINISHPAGE_LINK_COLOR </span><span class="parameter">(color: 0xBBGGRR hexadecimal)</span><br />
Text color for the link on the Finish page.<br /><i>Default: 0x800000</i></p>
<p class="text"><span class="bold">MUI_RTL_UI</span><br />
Right-to-left interface.</p>
</div>
<p class="sub2header">Components Page Interface Settings</p>
<div class="margin">
<p class="text"><span class="bold">MUI_COMPONENTSPAGE_SMALLDESC</span><br />
A small description area on the bottom of the page. Use this layout
if you have a lot of sections and don't need large descriptions.</p>
<p class="text"><span class="bold">MUI_COMPONENTSPAGE_NODESC</span><br />
No description area.</p>
</div>
<p class="sub2header">Message Settings</p>
<div class="margin">
<p class="text"><span class="bold">MUI_ABORTWARNING</span><br />
Show a message box with a warning when the user wants to close the installer.</p>
</div>
<p class="subheader">5. Define custom functions (optional)</p>
<p class="text">If you want add your own code to functions inserted by the
Modern UI (i.e. the .onGUIInit function and the page functions), create your
@ -367,33 +413,24 @@ parameters.</p>
<pre class="margin">!insertmacro MUI_LANGUAGE "English"</pre>
<p class="text">The Modern UI language files load the NLF language files,
so you should not use LoadLanguageFile.</p>
<p class="sub2header">Customize Modern UI text</p>
<div class="margin">
<p class="text">You don't need to edit the language files if you want to customize
some strings. Use defines before you insert the language file:</p>
<pre class="margin">
!define MUI_BRANDINGTEXT "French Branding Text"
!insertmacro MUI_LANGUAGE "French"
!define MUI_TEXT_COMPONENTS_TITLE "Your text"
!insertmacro MUI_LANGUAGE "English"
</pre>
<p class="text"><span class="bold">Note: </span>When using different product name (MUI_PRODUCT)
for different languges, !undef MUI_PRODUCT after inserting a language file.</p>
<p class="text">Have a look at the language files for a complete list of all the
string names.</p>
<p class="text">You can customize texts that can be set in the Classic UI using the LicenseText,
ComponentText, DirText and MiscButtonText commands but are not being changed by the Modern UI using
these defines:</p>
<p class="text">
<span class="bold">MUI_BUTTONTEXT_LICENSE </span><span class="parameter">text</span><br />
<span class="bold">MUI_BUTTONTEXT_BACK </span><span class="parameter">text</span><br />
<span class="bold">MUI_BUTTONTEXT_NEXT </span><span class="parameter">text</span><br />
<span class="bold">MUI_BUTTONTEXT_CANCEL </span><span class="parameter">text</span>
</p>
<p class="text">
<span class="bold">MUI_INNERTEXT_COMPONENTS_SUB1 </span><span class="parameter">text</span><br />
<span class="bold">MUI_INNERTEXT_COMPONENTS_SUB2 </span><span class="parameter">text</span>
</p>
<p class="text">
<span class="bold">MUI_TEXT_DIRECTORY_BROWSE </span><span class="parameter">text</span>
</p>
<p class="text">You can also customize the fonts for a language using the following defines:</p>
<p class="text"><span class="bold">Note: </span>When using different product name (MUI_PRODUCT)
for different languges, !undef MUI_PRODUCT after inserting a language file (or use a language
string).</p>
</div>
<p class="sub2header">Customize fonts</p>
<div class="margin">
<p class="text">You can customize the fonts for a language using the following defines before inserting
a language:</p>
<p class="text"><span class="bold">MUI_FONT_HEADER </span><span class="parameter">font_name</span><br />
<span class="bold">MUI_FONTSIZE_HEADER </span><span class="parameter">font_size</span><br />
<span class="bold">MUI_FONTSTYLE_HEADER </span><span class="parameter">weight [/ITALIC] [/UNDERLINE] [/STRIKE]</span><br />
@ -402,6 +439,16 @@ parameters.</p>
<span class="bold">MUI_FONTSIZE_TITLE </span><span class="parameter">font_size</span><br />
<span class="bold">MUI_FONTSTYLE_TITLE </span><span class="parameter">weight [/ITALIC] [/UNDERLINE] [/STRIKE]</span><br />
The font for the title on the Welcome and Finish page.</p>
</div>
<p class="sub2header">Customize other texts</p>
<div class="margin">
<p class="text">To customize button texts, use the following defines.</p>
<p class="text">
<span class="bold">MUI_BUTTONTEXT_BACK </span><span class="parameter">text</span><br />
<span class="bold">MUI_BUTTONTEXT_NEXT </span><span class="parameter">text</span><br />
<span class="bold">MUI_BUTTONTEXT_CANCEL </span><span class="parameter">text</span>
</p>
</div>
<p class="sub2header">Language selection dialog</p>
<div class="margin">
<p class="text">If you want the installer to display a language selection dialog
@ -456,11 +503,13 @@ SectionEnd
LangString DESC_Section1 ${LANG_ENGLISH} "Description of section 1."
LangString DESC_Section2 ${LANG_ENGLISH} "Description of section 2."
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
!insertmacro MUI_DESCRIPTION_TEXT ${Section2} $(DESC_Section2)
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
!insertmacro MUI_FUNCTION_DESCRIPTION_END
</pre>
<p class="text">For the uninstaller, use the MUI_UNFUNCTION_DESCRIPTION_BEGIN
and MUI_UNFUNCTIONS_DESCRIPTION_END macros</p>
<p class="subheader">8. Reserve Files</p>
<p class="text">If you are using BZIP2 compression, you might need to
insert ReserveFile commands. <a href="#ReserveFile">More info...</a></p>
@ -593,12 +642,12 @@ ReserveFile "${NSISDIR}\Contrib\Icons\modern-header.bmp" ;Your header bitmap
To change them, you need to edit this file and recompile NSIS.</p>
<p class="text">To modify the Welcome and Finish dialog, edit the Install
Options INI File ioSpecial.ini in the 'Contrib\Modern UI' directory.</p>
<p class="header">Customize Modern UI Functions</p>
<a name="customFunctions"></a><p class="text">If you want add your own code to functions
inserted by the Modern UI, such as the .onGUIInit function and the Page functions,
create your own function and let the Modern UI functions call them. Use the defines
to define the name of your functions. Add the defines before the MUI_LANGUAGE macros.</p>
<p class="text">Example:</p>
<p class="header"><a name="customFunctions">Customize Modern UI Functions</a></p>
<p class="text">If you want add your own code to functions
inserted by the Modern UI, such as the .onGUIInit function and the Page functions,
create your own function and let the Modern UI functions call them. Use the defines
to define the name of your functions. Add the defines before the MUI_LANGUAGE macros.</p>
<p class="text">Example:</p>
<pre class="text">
!define MUI_CUSTOMFUNCTION_GUIINIT myGuiInit
@ -606,71 +655,39 @@ Function myGUIInit
...your own code...
FunctionEnd
</pre>
<p class="text">
<span class="bold">GUI Init</span><br />
MUI_CUSTOMFUNCTION_GUIINIT<br />
MUI_CUSTOMFUNCTION_UNGUIINIT
</p>
<p class="text">
<span class="bold">Welcome Page</span><br />
MUI_CUSTOMFUNCTION_WELCOME_PRE - You can write to the IO INI file of the page (ioSpecial.ini)<br />
MUI_CUSTOMFUNCTION_WELCOME_SHOW - $MUI_HWND contains the HWND of the Welcome dialog
MUI_CUSTOMFUNCTION_WELCOME_LEAVE
</p>
<p class="text">
<span class="bold">License Page</span><br />
MUI_CUSTOMFUNCTION_LICENSE_PRE<br />
MUI_CUSTOMFUNCTION_LICENSE_SHOW<br />
MUI_CUSTOMFUNCTION_LICENSE_LEAVE
</p>
<p class="text">
<span class="bold">Components Page</span><br />
MUI_CUSTOMFUNCTION_COMPONENTS_PRE<br />
MUI_CUSTOMFUNCTION_COMPONENTS_SHOW<br />
MUI_CUSTOMFUNCTION_COMPONENTS_LEAVE
</p>
<p class="text">
<span class="bold">Directory Page</span><br />
MUI_CUSTOMFUNCTION_DIRECTORY_PRE<br />
MUI_CUSTOMFUNCTION_DIRECTORY_SHOW<br />
MUI_CUSTOMFUNCTION_DIRECTORY_LEAVE
</p>
<p class="text">
<span class="bold">Start Menu Folder Page</span><br />
MUI_CUSTOMFUNCTION_STARTMENU_PRE<br />
MUI_CUSTOMFUNCTION_STARTMENU_LEAVE
</p>
<p class="text">
<span class="bold">Install Page</span><br />
MUI_CUSTOMFUNCTION_INSTFILES_PRE<br />
MUI_CUSTOMFUNCTION_INSTFILES_SHOW<br />
MUI_CUSTOMFUNCTION_INSTFILES_LEAVE
</p>
<p class="text">
<span class="bold">Finish Page</span><br />
MUI_CUSTOMFUNCTION_FINISH_PRE - You can write to the IO INI file of the page (ioSpecial.ini)<br />
MUI_CUSTOMFUNCTION_FINISH_SHOW - $MUI_HWND contains the HWND of the Finish dialog
MUI_CUSTOMFUNCTION_FINISH_LEAVE
</p>
<p class="text">
<span class="bold">Installer Abort</span><br />
MUI_CUSTOMFUNCTION_ABORT
</p>
<p class="text">
<span class="bold">Uninstaller - Confirm Page</span><br />
MUI_UNCUSTOMFUNCTION_CONFIRM_PRE<br />
MUI_UNCUSTOMFUNCTION_CONFIRM_SHOW<br />
MUI_UNCUSTOMFUNCTION_CONFIRM_LEAVE
</p>
<p class="text">
<span class="bold">Uninstaller - Uninstall Page</span><br />
MUI_UNCUSTOMFUNCTION_INSTFILES_PRE<br />
MUI_UNCUSTOMFUNCTION_INSTFILES_SHOW<br />
MUI_UNCUSTOMFUNCTION_INSTFILES_LEAVE
</p>
<p class="sub2header">General Custom Functions</p>
<div class="margin">
<p class="text">MUI_CUSTOMFUNCTION_GUIINIT<br />
MUI_CUSTOMFUNCTION_UNGUIINIT<br />
MUI_CUSTOMFUNCTION_ABORT</p>
</div>
<p class="sub2header">Page Custom Functions</p>
<div class="margin">
<p class="text">These defines should be set before inserting a page macro.</p>
<p class="text">MUI_PAGE_CUSTOMFUNCTION_PRE<br />
MUI_PAGE_CUSTOMFUNCTION_SHOW<br />
MUI_PAGE_CUSTOMFUNCTION_LEAVE</p>
<p class="text"><span class="bold">Notes:</span></p>
<ul>
<li>The StartMenu page does not have a Show function</li>
<li>In the Pre function of the Welcome- and Finish page, you can write to the InstallOptions INI file
of the page (ioSpecial.ini)</li>
<li>In the Show function of Welcome- and Finish page, $MUI_HWND contains the HWND of the inner dialog.</li>
</ul>
</div>
<p class="header">Version history</p>
<ul>
<li>1.65 - July 16, 2003
<li>1.66 - September 4
<ul>
<li>New system for page settings and custom pages</li>
<li>Support for uninstaller components page</li>
<li>Support for multiple pages of the same type</li>
<li>Changed macro names</li>
<li>Updated langauge system, new language files</li>
</ul></li>
</ul>
<ul>
<li>1.65 - August 12, 2003
<ul>
<li>New page configuration system, no different system for installers
with custom pages</li>
@ -707,16 +724,16 @@ MUI_UNCUSTOMFUNCTION_INSTFILES_LEAVE
<li>Language files have to be updated</li>
</ul></li>
</ul>
<p class="text"><a href="Changelog.txt">Complete version history</a></p>
<p class="header">Credits</p>
<p class="text">Made by Joost Verburg.<br />
Icons designed by Nikos Adamamas, aka adni18.<br />
Thanks to Amir Szekely, aka KiCHiK, for his work on NSIS
to make this possible.</p>
<p class="header">Help</p>
<p class="text">Please post questions at the
<a href="http://forums.winamp.com/forumdisplay.php?forumid=65">NSIS Forum</a>.</p>
<p class="header">License</p>
<p class="text"><a href="Changelog.txt">Complete version history</a></p>
<p class="header">Credits</p>
<p class="text">Made by Joost Verburg.<br />
Icons designed by Nikos Adamamas, aka adni18.<br />
Thanks to Amir Szekely, aka KiCHiK, for his work on NSIS
to make this possible.</p>
<p class="header">Help</p>
<p class="text">Please post questions at the
<a href="http://forums.winamp.com/forumdisplay.php?forumid=65">NSIS Forum</a>.</p>
<p class="header">License</p>
<pre class="margin">Copyright &copy; 2002-2003 Joost Verburg
This software is provided 'as-is', without any express or implied

File diff suppressed because it is too large Load diff

Binary file not shown.

View file

@ -25,10 +25,15 @@
;Get install folder from registry if available
InstallDirRegKey HKCU "Software\${MUI_PRODUCT}" ""
;--------------------------------
;Modern UI Configuration
!define MUI_ABORTWARNING
;--------------------------------
;Pages
!insertmacro MUI_PAGE_LICENSE
!insertmacro MUI_PAGE_LICENSE "${NSISDIR}\Contrib\Modern UI\License.txt"
!insertmacro MUI_PAGE_COMPONENTS
!insertmacro MUI_PAGE_DIRECTORY
!insertmacro MUI_PAGE_INSTFILES
@ -36,21 +41,11 @@
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
;--------------------------------
;Modern UI Configuration
!define MUI_ABORTWARNING
;--------------------------------
;Languages
!insertmacro MUI_LANGUAGE "English"
;--------------------------------
;Data
LicenseData "${NSISDIR}\Contrib\Modern UI\License.txt"
;--------------------------------
;Installer Sections
@ -73,9 +68,9 @@ SectionEnd
LangString DESC_SecDummy ${LANG_ENGLISH} "A test section."
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${SecDummy} $(DESC_SecDummy)
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
!insertmacro MUI_FUNCTION_DESCRIPTION_END
;--------------------------------
;Uninstaller Section

View file

@ -1,4 +1,4 @@
;NSIS Modern User Interface version 1.65
;NSIS Modern User Interface version 1.66
;Header Bitmap Example Script
;Written by Joost Verburg
@ -25,10 +25,16 @@
;Get install folder from registry if available
InstallDirRegKey HKCU "Software\${MUI_PRODUCT}" ""
;--------------------------------
;Modern UI Configuration
!define MUI_HEADERBITMAP "${NSISDIR}\Contrib\Icons\modern-header.bmp"
!define MUI_ABORTWARNING
;--------------------------------
;Pages
!insertmacro MUI_PAGE_LICENSE
!insertmacro MUI_PAGE_LICENSE "${NSISDIR}\Contrib\Modern UI\License.txt"
!insertmacro MUI_PAGE_COMPONENTS
!insertmacro MUI_PAGE_DIRECTORY
!insertmacro MUI_PAGE_INSTFILES
@ -36,22 +42,11 @@
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
;--------------------------------
;Modern UI Configuration
!define MUI_HEADERBITMAP "${NSISDIR}\Contrib\Icons\modern-header.bmp"
!define MUI_ABORTWARNING
;--------------------------------
;Languages
!insertmacro MUI_LANGUAGE "English"
;--------------------------------
;Data
LicenseData "${NSISDIR}\Contrib\Modern UI\License.txt"
;--------------------------------
;Reserve Files
@ -82,9 +77,9 @@ SectionEnd
LangString DESC_SecDummy ${LANG_ENGLISH} "A test section."
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${SecDummy} $(DESC_SecDummy)
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
!insertmacro MUI_FUNCTION_DESCRIPTION_END
;--------------------------------
;Uninstaller Section

View file

@ -1,4 +1,4 @@
;NSIS Modern User Interface version 1.65
;NSIS Modern User Interface version 1.66
;InstallOptions Example Script
;Written by Joost Verburg
@ -33,7 +33,7 @@
;--------------------------------
;Pages
!insertmacro MUI_PAGE_LICENSE
!insertmacro MUI_PAGE_LICENSE "${NSISDIR}\Contrib\Modern UI\License.txt"
Page custom CustomPageA
!insertmacro MUI_PAGE_COMPONENTS
Page custom CustomPageB
@ -54,11 +54,6 @@
!insertmacro MUI_LANGUAGE "English"
;--------------------------------
;Data
LicenseData "${NSISDIR}\Contrib\Modern UI\License.txt"
;--------------------------------
;Reserve Files
@ -135,9 +130,9 @@ FunctionEnd
LangString DESC_SecDummy ${LANG_ENGLISH} "A test section."
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${SecDummy} $(DESC_SecDummy)
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
!insertmacro MUI_FUNCTION_DESCRIPTION_END
;--------------------------------
;Uninstaller Section

View file

@ -1,4 +1,4 @@
;NSIS Modern User Interface version 1.65
;NSIS Modern User Interface version 1.66
;Multilingual Example Script
;Written by Joost Verburg
@ -24,17 +24,7 @@
;Get install folder from registry if available
InstallDirRegKey HKCU "Software\${MUI_PRODUCT}" ""
;--------------------------------
;Pages
!insertmacro MUI_PAGE_COMPONENTS
!insertmacro MUI_PAGE_DIRECTORY
!insertmacro MUI_PAGE_INSTFILES
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
;--------------------------------
;Modern UI Configuration
@ -45,6 +35,16 @@
!define MUI_ABORTWARNING
;--------------------------------
;Pages
!insertmacro MUI_PAGE_COMPONENTS
!insertmacro MUI_PAGE_DIRECTORY
!insertmacro MUI_PAGE_INSTFILES
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
;--------------------------------
;Languages
@ -148,9 +148,9 @@ FunctionEnd
LangString DESC_SecDummy ${LANG_CATALAN} "Test section: Catalan description"
LangString DESC_SecDummy ${LANG_SERBIAN} "Test section: Serbian description"
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${SecDummy} $(DESC_SecDummy)
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
!insertmacro MUI_FUNCTION_DESCRIPTION_END
;--------------------------------
;Uninstaller Section

View file

@ -1,4 +1,4 @@
;NSIS Modern User Interface version 1.65
;NSIS Modern User Interface version 1.66
;Start Menu Folder Selection Example Script
;Written by Joost Verburg
@ -30,38 +30,35 @@
Var MUI_TEMP
;--------------------------------
;Modern UI Configuration
!define MUI_ABORTWARNING
;--------------------------------
;Pages
!insertmacro MUI_PAGE_LICENSE
!insertmacro MUI_PAGE_LICENSE "${NSISDIR}\Contrib\Modern UI\License.txt"
!insertmacro MUI_PAGE_COMPONENTS
!insertmacro MUI_PAGE_DIRECTORY
;Start Menu Folder Page Configuration
!define MUI_STARTMENUPAGE_REGISTRY_ROOT "HKCU"
!define MUI_STARTMENUPAGE_REGISTRY_KEY "Software\${MUI_PRODUCT}"
!define MUI_STARTMENUPAGE_REGISTRY_VALUENAME "Start Menu Folder"
!insertmacro MUI_PAGE_STARTMENU
!insertmacro MUI_PAGE_INSTFILES
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
;--------------------------------
;Modern UI Configuration
!define MUI_ABORTWARNING
;Remember the Start Menu Folder
!define MUI_STARTMENUPAGE_REGISTRY_ROOT "HKCU"
!define MUI_STARTMENUPAGE_REGISTRY_KEY "Software\${MUI_PRODUCT}"
!define MUI_STARTMENUPAGE_REGISTRY_VALUENAME "Start Menu Folder"
;--------------------------------
;Languages
!insertmacro MUI_LANGUAGE "English"
;--------------------------------
;Data
LicenseData "${NSISDIR}\Contrib\Modern UI\License.txt"
;--------------------------------
;Reserve Files
@ -99,9 +96,9 @@ SectionEnd
LangString DESC_SecDummy ${LANG_ENGLISH} "A test section."
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${SecDummy} $(DESC_SecDummy)
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
!insertmacro MUI_FUNCTION_DESCRIPTION_END
;--------------------------------
;Uninstaller Section

View file

@ -1,4 +1,4 @@
;NSIS Modern User Interface version 1.65
;NSIS Modern User Interface version 1.66
;Welcome/Finish Page Example Script
;Written by Joost Verburg
@ -25,11 +25,16 @@
;Get install folder from registry if available
InstallDirRegKey HKCU "Software\${MUI_PRODUCT}" ""
;--------------------------------
;Modern UI Configuration
!define MUI_ABORTWARNING
;--------------------------------
;Pages
!insertmacro MUI_PAGE_WELCOME
!insertmacro MUI_PAGE_LICENSE
!insertmacro MUI_PAGE_LICENSE "${NSISDIR}\Contrib\Modern UI\License.txt"
!insertmacro MUI_PAGE_COMPONENTS
!insertmacro MUI_PAGE_DIRECTORY
!insertmacro MUI_PAGE_INSTFILES
@ -38,21 +43,11 @@
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
;--------------------------------
;Modern UI Configuration
!define MUI_ABORTWARNING
;--------------------------------
;Languages
!insertmacro MUI_LANGUAGE "English"
;--------------------------------
;Data
LicenseData "${NSISDIR}\Contrib\Modern UI\License.txt"
;--------------------------------
;Reserve Files
@ -83,9 +78,9 @@ SectionEnd
LangString DESC_SecDummy ${LANG_ENGLISH} "A test section."
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${SecDummy} $(DESC_SecDummy)
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
!insertmacro MUI_FUNCTION_DESCRIPTION_END
;--------------------------------
;Uninstaller Section