diff -r 000000000000 -r d5ce4c64ef88 Docs/ExperienceUI/pages/macros.htm --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Docs/ExperienceUI/pages/macros.htm Tue Oct 16 00:07:41 2007 -0400 @@ -0,0 +1,97 @@ + + + ExperienceUI Documentation Content Frame + + + + + + + + + + + + + + + + + + + +
+ + + +

Abort Page

+ +

+ XPUI_USERABORT - Invokes the abort page immediately. Use this in .onUserAbort or any time after the GUI has been initialized. Please note that you cannot call this macro in .onInit or any other function when the installer GUI has not yet been drawn. Here is an example .onUserAbort function that utilizes the ExperienceUI Abort Page: +

+ + Function .onUserAbort
+   StrCmp $NOABORTWARNING 1 AbortMe
+   MessageBox MB_YESNO|MB_ICONQUESTION "Are you sure you want to cancel Setup?" IDNO NoAbort
+   !insertmacro XPUI_USERABORT
+   NoAbort:
+   Abort
+   AbortMe:
+ FunctionEnd +
+
+
+ + + +

Reserve Files

+ +

+ Note: To reserve files, define XPUI_RESERVEFILES now. The macros below are shown only for historical reference. +

+ +

+ XPUI_RESERVEFILE_HEADERIMAGE - DEPRECATED – Adds the header image to the earlier data blocks of the installer. This can speed up loading in larger setups. Insert this before the XPUI_FUNCTION_GUIINIT macro and before any file commands.
+
+ XPUI_RESERVEFILE_LEFTBRANDINGIMAGE - DEPRECATED – Adds the left branding image (the bitmap on the left of the installer) to the earlier data blocks of the installer. This can speed up loading in larger setups. Insert this before the XPUI_FUNCTION_GUIINIT macro and before any file commands.
+
+ XPUI_RESERVEFILE_BOTTOMIMAGE - DEPRECATED – Adds the bottom button panel image to the earlier data blocks of the installer. This can speed up loading in larger setups. Insert this before the XPUI_FUNCTION_GUIINIT macro and before any file commands.
+
+

+ + + +

Information Panel

+ +

+ XPUI_LEFT_BLANK - Blanks out the information panel. You should insert this in the PRE function of the Abort page if you are using time counters in the installer. After XPUI_LEFT_MESSAGE is called, this is called automatically.
+
+ XPUI_LEFT_SETTIME "# Minutes" - Sets the text on the information panel to "# Minutes". You can call this anytime after .GUIInit is called by the NSIS core. You can also insert XPUI_LEFT_SETTIME "Less than 1 minute" or XPUI_LEFT_SETTIME "Sometime in the next millennium" or whatever you want.
+
+ XPUI_LEFT_MESSAGE "Text at top" "Body Text" Type# - Shows a color-theme aware message box on the left info panel. This must be used in a custom page function. Replace Type# with 1 (OK button), 2 (OK/Cancel buttons), or 3 (Yes/No buttons). To get the return, use ReadINIStr $var $PLUGINSDIR\MBSide.ini Settings State. The return value will be either 1 (OK for Type 1), 2 (OK for type 2 or Yes), or 3 (Cancel or No). After you get the return value, you need to delete the file manually. Example:
+

+ Page custom MessageBox MBFin ": My Message Box"
+
+ Function MessageBox
+ !insertmacro XPUI_LEFT_MESSAGE "Just so you know..." "The XPUI can do message boxes too!" 2
+ FunctionEnd
+
+ Function MBFin
+ ReadINIStr $R0 $PLUGINSDIR\MBSide.ini "Settings" State
+ StrCmp $R0 2 "" +2
+ MessageBox MB_OK "You clicked OK, user!" IDOK +2
+ MessageBox MB_OK "You clicked Cancel, user!"
+ Delete $PLUGINSDIR\MBSide.ini
+ FunctionEnd

+

+

+ +
+ + + +
+ + + +