3. Define settings
+3. Defines
Use defines to let the Modern UI know what it should insert. Most defines (i.e. MUI_WELCOMEPAGE) don't need - a value, but others should be used to define a value for the - Modern UI (i.e. MUI_FINISHPAGE_RUN):
+ a value, there are true/false settings. Others + (i.e. MUI_FINISHPAGE_RUN) can be used to define a specific + value, the value type is given next to the define name: + MUI_FINISHPAGE_RUN [exe_file]. + When there multiple values or optional flags, put them all + between the quotes.-!define MUI_WELCOMEPAGE -!define MUI_FINISHPAGE_RUN "$INSTDIR\Application.exe" +!define MUI_WELCOMEPAGE ;No value +!define MUI_FINISHPAGE_RUN "$INSTDIR\Application.exe" ;Value +!define MUI_FONTSTYLE_HEADER "700 /ITALIC"-
All defines are optional. If you don't define - a page or option, the page won't use or show it.
+All defines are optional.
+3a. General settings
MUI_WELCOMEPAGE
Show the welcome page. The welcome page is an introduction
and shows information for the user.
MUI_STARTMENUPAGE_VARIABLE
+
MUI_STARTMENUPAGE_VARIABLE [variable]
Variable to store the current Start Menu Folder. Default is $9.
You cannot use this variable in your script (or you should Push/Pop it).e.
MUI_STARTMENUPAGE_DEFAULTFOLDER
+
MUI_STARTMENUPAGE_DEFAULTFOLDER [folder]
The default Start Menu Folder. Use $(LANGSTRINGNAME) as value is you want
to use a language string.
MUI_STARTMENUPAGE_NODISABLE
Do not display the checkbox to disable the creation of Start Menu
shortcuts.
MUI_STARTMENUPAGE_REGISTRY_ROOT,
- MUI_STARTMENUPAGE_REGISTRY_KEY, MUI_STARTMENUPAGE_REGISTRY_VALUENAME
+
MUI_STARTMENUPAGE_REGISTRY_ROOT [root],
+ MUI_STARTMENUPAGE_REGISTRY_KEY [key], MUI_STARTMENUPAGE_REGISTRY_VALUENAME [value_name]
The registry key to store the Start Menu folder. The page will use it to
remember the users preference. You should also use it in the uninstaller to
remove the Start Menu folders. Don't forget to remove this key in the
@@ -195,18 +200,18 @@ follow these steps:
MUI_FINISHPAGE_RUN
+
MUI_FINISHPAGE_RUN [exe_file]
Application which the user can select to run (using a checkbox).
You don't need to put quotes around the filename when it contains spaces.
MUI_FINISHPAGE_RUN_PARAMETERS
+
MUI_FINISHPAGE_RUN_PARAMETERS [parameters]
Parameters for the application to run. Don't forget to escape double
quotes in the value (use $\").
MUI_FINISHPAGE_RUN_NOTCHECKED
Do not check the 'Run program' checkbox by default
MUI_FINISHPAGE_SHOWREADME
- File which the user can select to view (using a checkbox).
+
MUI_FINISHPAGE_SHOWREADME [file/url]
+ 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 is you want to use a language string.
4. Define interface settings (optional)
-You can also change the settings of the interface by using defines:
-!define MUI_ICON "myicon.ico"-
If you don't define a setting, the default will be used.
-The following settings are available: (default values)
-MUI_UI (${NSISDIR}\Contrib\UIs\modern.exe)
+
3b. Interface settings
+If a defualt value is specified after the define name and values, the default will + be used when the value has not been defined.
+MUI_UI [ui_file] (${NSISDIR}\Contrib\UIs\modern.exe)
The interface file with the dialog resources. Change this if you have made your own customized UI.
MUI_UI_HEADERBITMAP, MUI_UI_HEADERBITMAP_RIGHT +
MUI_UI_HEADERBITMAP [ui_file], MUI_UI_HEADERBITMAP_RIGHT [ui_file]
(${NSISDIR}\Contrib\UIs\modern-headerbmp(r).exe)
The interface files with the dialog resource IDD_INST that contains a bitmap control and space for
the header bitmap.
MUI_UI_SMALLDESCRIPTION, MUI_UI_NODESCRIPTION
(${NSISDIR}\Contrib\UIs\modern-(small/no)desc.exe)
The interface files with a customized dialog resource IDD_SELCOM for a small or no description area.
MUI_ICON (${NSISDIR}\Contrib\Icons\modern-install.ico)
+
MUI_ICON [icon_file] (${NSISDIR}\Contrib\Icons\modern-install.ico)
The icon of the installer.
MUI_UNICON (${NSISDIR}\Contrib\Icons\modern-uninstall.ico)
+
MUI_UNICON [icon_file] (${NSISDIR}\Contrib\Icons\modern-uninstall.ico)
The icon of the uninstaller.
MUI_CHECKBITMAP (${NSISDIR}\Contrib\Icons\modern.bmp)
+
MUI_CHECKBITMAP [bitmap_file] (${NSISDIR}\Contrib\Icons\modern.bmp)
The bitmap with images for the checks of the component select treeview.
MUI_FONT, MUI_FONTSIZE (MS Shell Dlg, 8)
+
MUI_FONT [font_name], MUI_FONTSIZE [font_size] (MS Shell Dlg, 8)
The font for the normal texts.
MUI_FONT_HEADER, MUI_FONTSIZE_HEADER, MUI_FONTSTYLE_HEADER +
MUI_FONT_HEADER [font_name], MUI_FONTSIZE_HEADER [font_size], MUI_FONTSTYLE_HEADER
+ [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]
(MS Shell Dlg, 8, 700)
- The font for the title in the header. Fontstyle: [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]
MUI_FONT_TITLE, MUI_FONTSIZE_TITLE, MUI_FONTSTYLE_TITLE + The font for the title in the header.
+MUI_FONT_TITLE [font_name], MUI_FONTSIZE_TITLE [font_size], MUI_FONTSTYLE_TITLE
+ [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]
(Verdana, 12, 700)
- The font for the title on the Welcome and Finish page. Fontstyle: [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]
MUI_INSTALLCOLORS (/windows)
- The colors of the details screen, hexadecimal RRGGBB. ("foreground" "background")
MUI_INSTALLCOLORS [foreground color, RRBBGG] [background color, RRGGBB]
+ (/windows)
The colors of the details screen. Use /windows instead of the colors to use the Windows
+ colors (the default).
MUI_PROGRESSBAR (smooth)
The style of the progress bar ("colored" to use the MUI_INSTALLCOLORS or "" for an old-school
windows look).
MUI_HEADERBITMAP (not defined)
+
MUI_HEADERBITMAP [bmp_file] (not defined)
Bitmap to display in the white header. With the default DPI, a bitmap with a size 150x57 won't have to be resized.
An example of a header bitmap is ${NSISDIR}\Contrib\Icons\modern-header.bmp, but can also make one with your own
logo.
MUI_HEADERBITMAP_RIGHT (not defined)
- Put the header bitmap on the right side of the header instead of the left side.
MUI_SPECIALINI (${NSISDIR}\Contrib\Modern UI\ioSpecial.ini)
+
MUI_SPECIALINI [ini_file] (${NSISDIR}\Contrib\Modern UI\ioSpecial.ini)
Install Options INI File for the Welcome and Finish page.
MUI_SPECIALBITMAP (${NSISDIR}\Contrib\Icons\modern-wizard.bmp)
+
MUI_SPECIALBITMAP [bmp_file] (${NSISDIR}\Contrib\Icons\modern-wizard.bmp)
Bitmap for the Welcome and Finish page.
MUI_BGCOLOR (0xFFFFFF)
- Background color for the header, Welcome page and Finish page, hexadecimal. (0xBBGGRR)
MUI_BGCOLOR [color 0xBBGGRR] (0xFFFFFF)
+ Background color for the header, Welcome page and Finish page.
MUI_RTL_UI (not defined)
Right-to-left interface.
6. Define custom functions (optional)
+4. Define custom functions (optional)
If you want add your own code to functions inserted by the Modern UI, such as the .onGUIInit function and the Page function, create your own function and let the Modern UI functions call them..
-7. Insert custom pages (optional)
+5. Insert custom pages (optional)
If you want to use custom pages (define MUI_CUSTOMPAGECOMMANDS or MUI_UNCUSTOMPAGECOMMANDS), insert them before inserting the language files.
-8. Insert language files
+6. Insert language files
Insert the Modern UI language files for the languages you are using:
!insertmacro MUI_LANGUAGE "English"
The Modern UI language files load the NLF language files, @@ -324,8 +331,8 @@ FunctionEnd and MUI_STARTMENUPAGE_REGISTRY_VALUENAME to set a registry key to store the language. You can also use it in the uninstaller to display the right language. Don't forget to remove this key in the uninstaller.
-9. Insert the MUI_SECTIONS_FINISHHEADER macro
-If you are not using a Finish page without defining +
7. Insert the MUI_SECTIONS_FINISHHEADER macro
+If you are not using a Finish page without MUI_FINISHPAGE_NOAUTOCLOSEWINDOW and have not set AutoCloseWindow to true, you should insert the MUI_SECTIONS_FINISHHEADER after all the sections to display the finish header:
@@ -335,7 +342,7 @@ Uninstall section:!insertmacro MUI_UNFINISHHEADER-
10. Set the descriptions for the sections
+8. Set the descriptions for the sections
Insert the description macro's to set the descriptions for the sections. These descriptions will be displayed on the component selection page, when the users hovers the mouse over a section. @@ -356,7 +363,7 @@ Section "Section Name 1" Section1 ... SectionEnd -
10. Reserve Files
+9. Reserve Files
If you are using BZIP2 compression, you might need to insert ReserveFile commands. More info...
@@ -369,14 +376,14 @@ For the normal Modern UI pages, insert one of the PAGECOMMAND macro's: !insertmacro MUI_PAGECOMMAND_LICENSE !insertmacro MUI_PAGECOMMAND_COMPONENTS !insertmacro MUI_PAGECOMMAND_DIRECTORY -Page custom FunctionName ;A custom page +Page custom FunctionName ;Custom page !insertmacro MUI_PAGECOMMAND_INSTFILES !insertmacro MUI_PAGECOMMAND_FINISHFor the uninstaller:
!insertmacro MUI_UNPAGECOMMAND_CONFIRM -UninstPage custom un.FunctionName ;A custom page +UninstPage custom un.FunctionName ;Custom page !insertmacro MUI_UNPAGECOMMAND_INSTFILES
Don't forget to define MUI_CUSTOMPAGECOMMANDS or @@ -492,10 +499,18 @@ ReserveFile "ioFile.ini" ;Your own InstallOptions INI files
To modify the Welcome and Finish dialog, edit the Install Options INI File ioWizard.ini in the 'Contrib\Modern UI' directory.
Customize Modern UI Functions
-If you want add your own code to functions inserted by the -Modern UI, such as the .onGUIInit function and the Page function, create your -own function and let the Modern UI functions call them. Use these -defines to define the name of your functions:
+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.
+Example:
++!define MUI_CUSTOMFUNCTION_ONGUIINIT myGuiInit + +Function myGUIInit + ...your own code... +FunctionEnd +
GUI Init
MUI_CUSTOMFUNCTION_GUIINIT
@@ -557,14 +572,6 @@ MUI_UNCUSTOMFUNCTION_INSTFILES_PRE
MUI_UNCUSTOMFUNCTION_INSTFILES_SHOW
MUI_UNCUSTOMFUNCTION_INSTFILES_LEAVE
Example:
--!define MUI_CUSTOMFUNCTION_ONGUIINIT myGuiInit - -Function .myGUIInit - ...your own code... -FunctionEnd -
Version history