浏览代码

Doc: Update for WindowVisible and MainForm removal.

Jordan Russell 8 月之前
父节点
当前提交
7da3a11b05

+ 0 - 1
ISHelp/ISHelpGen/UIsxclassesParser.pas

@@ -248,7 +248,6 @@ begin
         end;
         end;
       end;
       end;
     end;
     end;
-    WriteLn(F, '<keyword value="MainForm" />');
     WriteLn(F, '<keyword value="WizardForm" />');
     WriteLn(F, '<keyword value="WizardForm" />');
     WriteLn(F, '<keyword value="UninstallProgressForm" />');
     WriteLn(F, '<keyword value="UninstallProgressForm" />');
   finally
   finally

+ 18 - 77
ISHelp/isetup.xml

@@ -1124,18 +1124,10 @@ DefaultGroupName=My Program
 
 
 <ul appearance="compact">
 <ul appearance="compact">
 <li><link topic="setup_appcopyright">AppCopyright</link></li>
 <li><link topic="setup_appcopyright">AppCopyright</link></li>
-<li><link topic="setup_backcolor">BackColor</link></li>
-<li><link topic="setup_backcolor">BackColor2</link></li>
-<li><link topic="setup_backcolordirection">BackColorDirection</link></li>
-<li><link topic="setup_backsolid">BackSolid</link></li>
 <li><link topic="setup_flatcomponentslist">FlatComponentsList</link></li>
 <li><link topic="setup_flatcomponentslist">FlatComponentsList</link></li>
 <li><link topic="setup_setupiconfile">SetupIconFile</link></li>
 <li><link topic="setup_setupiconfile">SetupIconFile</link></li>
 <li><link topic="setup_showcomponentsizes">ShowComponentSizes</link></li>
 <li><link topic="setup_showcomponentsizes">ShowComponentSizes</link></li>
 <li><link topic="setup_showtaskstreelines">ShowTasksTreeLines</link></li>
 <li><link topic="setup_showtaskstreelines">ShowTasksTreeLines</link></li>
-<li><link topic="setup_windowshowcaption">WindowShowCaption</link></li>
-<li><link topic="setup_windowstartmaximized">WindowStartMaximized</link></li>
-<li><link topic="setup_windowresizable">WindowResizable</link></li>
-<li><link topic="setup_windowvisible">WindowVisible</link></li>
 <li><link topic="setup_wizardimagealphaformat">WizardImageAlphaFormat</link></li>
 <li><link topic="setup_wizardimagealphaformat">WizardImageAlphaFormat</link></li>
 <li><link topic="setup_wizardimagefile">WizardImageFile</link></li>
 <li><link topic="setup_wizardimagefile">WizardImageFile</link></li>
 <li><link topic="setup_wizardimagestretch">WizardImageStretch</link></li>
 <li><link topic="setup_wizardimagestretch">WizardImageStretch</link></li>
@@ -1151,12 +1143,20 @@ DefaultGroupName=My Program
 
 
 <ul appearance="compact">
 <ul appearance="compact">
 <li><link topic="setup_alwayscreateuninstallicon">AlwaysCreateUninstallIcon</link></li>
 <li><link topic="setup_alwayscreateuninstallicon">AlwaysCreateUninstallIcon</link></li>
+<li><link topic="setup_windowvisible">BackColor</link></li>
+<li><link topic="setup_windowvisible">BackColor2</link></li>
+<li><link topic="setup_windowvisible">BackColorDirection</link></li>
+<li><link topic="setup_windowvisible">BackSolid</link></li>
 <li><link topic="setup_disableappenddir">DisableAppendDir</link></li>
 <li><link topic="setup_disableappenddir">DisableAppendDir</link></li>
 <li><link topic="setup_dontmergeduplicatefiles">DontMergeDuplicateFiles</link></li>
 <li><link topic="setup_dontmergeduplicatefiles">DontMergeDuplicateFiles</link></li>
 <li><link topic="setup_messagesfile">MessagesFile</link></li>
 <li><link topic="setup_messagesfile">MessagesFile</link></li>
 <li><link topic="setup_uninstalliconfile">UninstallIconFile</link></li>
 <li><link topic="setup_uninstalliconfile">UninstallIconFile</link></li>
 <li><link topic="setup_uninstalliconname">UninstallIconName</link></li>
 <li><link topic="setup_uninstalliconname">UninstallIconName</link></li>
 <li><link topic="setup_uninstallstyle">UninstallStyle</link></li>
 <li><link topic="setup_uninstallstyle">UninstallStyle</link></li>
+<li><link topic="setup_windowvisible">WindowResizable</link></li>
+<li><link topic="setup_windowvisible">WindowShowCaption</link></li>
+<li><link topic="setup_windowvisible">WindowStartMaximized</link></li>
+<li><link topic="setup_windowvisible">WindowVisible</link></li>
 <li><link topic="setup_wizardimagebackcolor">WizardImageBackColor</link></li>
 <li><link topic="setup_wizardimagebackcolor">WizardImageBackColor</link></li>
 <li><link topic="setup_wizardsmallimagebackcolor">WizardSmallImageBackColor</link></li>
 <li><link topic="setup_wizardsmallimagebackcolor">WizardSmallImageBackColor</link></li>
 </ul>
 </ul>
@@ -4032,41 +4032,6 @@ Keep the default set of selected tasks, but deselect the "desktopicon" task:<br/
 </body>
 </body>
 </setuptopic>
 </setuptopic>
 
 
-<setuptopic directive="BackColor" title="BackColor, BackColor2">
-<keyword value="BackColor2" />
-<setupvalid>A value in the form of <tt>$<i>bbggrr</i></tt>, where <tt>rr</tt>, <tt>gg</tt>, and <tt>bb</tt> specify the two-digit intensities (in hexadecimal) for red, green, and blue respectively. Or it may be one of the following predefined color names: clBlack, clMaroon, clGreen, clOlive, clNavy, clPurple, clTeal, clGray, clSilver, clRed, clLime, clYellow, clBlue, clFuchsia, clAqua, clWhite.</setupvalid>
-<setupdefault><tt>clBlue</tt> for <tt>BackColor</tt>,<br/><tt>clBlack</tt> for <tt>BackColor2</tt></setupdefault>
-<body>
-<p>The <tt>BackColor</tt> directive specifies the color to use at the top (or left, if <tt>BackColorDirection=lefttoright</tt>) of the setup window's gradient background. <tt>BackColor2</tt> specifies the color to use at the bottom (or right).</p>
-<p>The setting of <tt>BackColor2</tt> is ignored if <tt>BackSolid=yes</tt>.</p>
-<examples>
-<pre>
-BackColor=clBlue
-BackColor2=clBlack
-
-BackColor=$FF0000
-BackColor2=$000000
-</pre>
-</examples>
-</body>
-</setuptopic>
-
-<setuptopic directive="BackColorDirection">
-<setupvalid><tt>toptobottom</tt> or <tt>lefttoright</tt></setupvalid>
-<setupdefault><tt>toptobottom</tt></setupdefault>
-<body>
-<p>This determines the direction of the gradient background on the setup window. If <tt>BackColorDirection</tt> is <tt>toptobottom</tt>, it is drawn from top to bottom; if it is <tt>lefttoright</tt>, it is drawn from left to right.</p>
-</body>
-</setuptopic>
-
-<setuptopic directive="BackSolid">
-<setupvalid><link topic="yesnonotes"><tt>yes</tt> or <tt>no</tt></link></setupvalid>
-<setupdefault><tt>no</tt></setupdefault>
-<body>
-<p>This specifies whether to use a solid or gradient background on the setup window. If this is <tt>yes</tt>, the background is a solid color (the color specified by <tt>BackColor</tt>; <tt>BackColor2</tt> is ignored).</p>
-</body>
-</setuptopic>
-
 <setuptopic directive="AppName">
 <setuptopic directive="AppName">
 <body>
 <body>
 <p>This required directive specifies the name of the application being installed. Do not include the version number, as that is defined by the <link topic="setup_appversion">AppVersion</link> and/or <link topic="setup_appvername">AppVerName</link> directives. <tt>AppName</tt> is displayed throughout the Setup program and uninstaller in window titles, wizard pages, and dialog boxes. The value may include constants.</p>
 <p>This required directive specifies the name of the application being installed. Do not include the version number, as that is defined by the <link topic="setup_appversion">AppVersion</link> and/or <link topic="setup_appvername">AppVerName</link> directives. <tt>AppName</tt> is displayed throughout the Setup program and uninstaller in window titles, wizard pages, and dialog boxes. The value may include constants.</p>
@@ -4165,8 +4130,7 @@ CreateMutex 0&amp;, 0&amp;, "MyProgramsMutexName"
 
 
 <setuptopic directive="AppCopyright">
 <setuptopic directive="AppCopyright">
 <body>
 <body>
-<p>Specifies a copyright message that Setup will display in the bottom-right corner of Setup's background window when <link topic="setup_windowvisible">WindowVisible</link> is <tt>yes</tt>.</p>
-<p>The value of this directive is also used as the default value for the <link topic="setup_versioninfocopyright">VersionInfoCopyright</link> directive if it is not specified.</p>
+<p>The value of this directive is used as the default value for the <link topic="setup_versioninfocopyright">VersionInfoCopyright</link> directive if it is not specified.</p>
 <example><pre>AppCopyright=Copyright (C) 1997-2005 My Company, Inc.</pre></example>
 <example><pre>AppCopyright=Copyright (C) 1997-2005 My Company, Inc.</pre></example>
 </body>
 </body>
 </setuptopic>
 </setuptopic>
@@ -5084,39 +5048,16 @@ DiskSliceSize=1457664
 </body>
 </body>
 </setuptopic>
 </setuptopic>
 
 
-<setuptopic directive="WindowShowCaption">
-<setupvalid><link topic="yesnonotes"><tt>yes</tt> or <tt>no</tt></link></setupvalid>
-<setupdefault><tt>yes</tt></setupdefault>
-<body>
-<p>If set to <tt>no</tt>, Setup will be truly "full screen" -- it won't have a caption bar or border, and it will be on top of the taskbar.</p>
-<p>This directive has no effect if <tt>WindowVisible</tt> is not set to <tt>yes</tt>.</p>
-</body>
-</setuptopic>
-
-<setuptopic directive="WindowStartMaximized">
-<setupvalid><link topic="yesnonotes"><tt>yes</tt> or <tt>no</tt></link></setupvalid>
-<setupdefault><tt>yes</tt></setupdefault>
-<body>
-<p>If set to <tt>yes</tt>, the Setup program's background window will initially be displayed in a maximized state, where it won't cover over the taskbar.</p>
-<p>This directive has no effect if <tt>WindowVisible</tt> is not set to <tt>yes</tt>.</p>
-</body>
-</setuptopic>
-
-<setuptopic directive="WindowResizable">
-<setupvalid><link topic="yesnonotes"><tt>yes</tt> or <tt>no</tt></link></setupvalid>
-<setupdefault><tt>yes</tt></setupdefault>
-<body>
-<p>If set to <tt>no</tt>, the user won't be able to resize the Setup program's background window when it's not maximized.</p>
-<p>This directive has no effect if <tt>WindowVisible</tt> is not set to <tt>yes</tt>.</p>
-</body>
-</setuptopic>
-
-<setuptopic directive="WindowVisible">
-<setupvalid><link topic="yesnonotes"><tt>yes</tt> or <tt>no</tt></link></setupvalid>
-<setupdefault><tt>no</tt></setupdefault>
+<setuptopic directive="WindowVisible" title="BackColor, BackColor2, BackColorDirection, BackSolid, WindowResizable, WindowShowCaption, WindowStartMaximized, WindowVisible">
+<keyword value="BackColor" />
+<keyword value="BackColor2" />
+<keyword value="BackColorDirection" />
+<keyword value="BackSolid" />
+<keyword value="WindowResizable" />
+<keyword value="WindowShowCaption" />
+<keyword value="WindowStartMaximized" />
 <body>
 <body>
-<p>If set to <tt>yes</tt>, there will be a gradient background window displayed behind the wizard.</p>
-<p>Note that this is considered a legacy feature; it likely will be removed at some point in the future.</p>
+<p><i>Obsolete in 6.4.</i> These directives are no longer supported. In past versions, they were used to configure a 1990s-style gradient background behind the wizard window. This long-deprecated feature has been removed.</p>
 </body>
 </body>
 </setuptopic>
 </setuptopic>
 
 

+ 1 - 2
ISHelp/isxclasses.header2

@@ -1,11 +1,10 @@
 <body>
 <body>
 
 
-<p>Below is the list of support classes that can be used from within the Pascal script. There are also three support objects available globally:</p>
+<p>Below is the list of support classes that can be used from within the Pascal script. There are also two support objects available globally:</p>
 
 
 <ul>
 <ul>
 <li><tt><a name="WizardForm">WizardForm</a></tt> of type <anchorlink name="TWizardForm">TWizardForm</anchorlink>.</li>
 <li><tt><a name="WizardForm">WizardForm</a></tt> of type <anchorlink name="TWizardForm">TWizardForm</anchorlink>.</li>
 <li><tt><a name="UninstallProgressForm">UninstallProgressForm</a></tt> of type <anchorlink name="TUninstallProgressForm">TUninstallProgressForm</anchorlink>.</li>
 <li><tt><a name="UninstallProgressForm">UninstallProgressForm</a></tt> of type <anchorlink name="TUninstallProgressForm">TUninstallProgressForm</anchorlink>.</li>
-<li><tt><a name="MainForm">MainForm</a></tt> of type <anchorlink name="TMainForm">TMainForm</anchorlink> (only visible if <link topic="setup_windowvisible">WindowVisible</link> is set to <tt>yes</tt>.)</li>
 </ul>
 </ul>
 
 
 <p>Parameter type <tt>AnyString</tt> means both <tt>String</tt> and <tt>AnsiString</tt> can be used.</p>
 <p>Parameter type <tt>AnyString</tt> means both <tt>String</tt> and <tt>AnsiString</tt> can be used.</p>

+ 0 - 4
ISHelp/isxclasses.pas

@@ -804,10 +804,6 @@ TSetupForm = class(TUIStateForm)
   property SizeAndCenterOnShow: Boolean; read write;
   property SizeAndCenterOnShow: Boolean; read write;
 end;
 end;
 
 
-TMainForm = class(TSetupForm)
-  procedure ShowAboutBox;
-end;
-
 TWizardForm = class(TSetupForm)
 TWizardForm = class(TSetupForm)
   property CancelButton: TNewButton; read;
   property CancelButton: TNewButton; read;
   property NextButton: TNewButton; read;
   property NextButton: TNewButton; read;

+ 11 - 13
ISHelp/isxclasses_wordlists_generated.pas

@@ -27,18 +27,17 @@ var
     'TFolderTreeView', 'TFont', 'TFontStyle', 'TFontStyles', 'TForm', 'TFormBorderStyle',
     'TFolderTreeView', 'TFont', 'TFontStyle', 'TFontStyles', 'TForm', 'TFormBorderStyle',
     'TFormStyle', 'TGraphic', 'TGraphicControl', 'TGraphicsObject', 'THandleStream', 'TInputDirWizardPage',
     'TFormStyle', 'TGraphic', 'TGraphicControl', 'TGraphicsObject', 'THandleStream', 'TInputDirWizardPage',
     'TInputFileWizardPage', 'TInputOptionWizardPage', 'TInputQueryWizardPage', 'TKeyEvent',
     'TInputFileWizardPage', 'TInputOptionWizardPage', 'TInputQueryWizardPage', 'TKeyEvent',
-    'TKeyPressEvent', 'TLabel', 'TLinkLabel', 'TListBox', 'TListBoxStyle', 'TMainForm',
-    'TMemo', 'TNewButton', 'TNewCheckBox', 'TNewCheckListBox', 'TNewComboBox', 'TNewEdit',
-    'TNewLinkLabel', 'TNewListBox', 'TNewMemo', 'TNewNotebook', 'TNewNotebookPage', 'TNewProgressBar',
-    'TNewProgressBarState', 'TNewProgressBarStyle', 'TNewRadioButton', 'TNewStaticText',
-    'TNotifyEvent', 'TObject', 'TOutputMarqueeProgressWizardPage', 'TOutputMsgMemoWizardPage',
-    'TOutputMsgWizardPage', 'TOutputProgressWizardPage', 'TPanel', 'TPanelBevel', 'TPasswordEdit',
-    'TPen', 'TPenMode', 'TPenStyle', 'TPersistent', 'TPosition', 'TRadioButton', 'TRichEditViewer',
-    'TScrollingWinControl', 'TScrollStyle', 'TSetupForm', 'TShiftState', 'TSizeConstraints',
-    'TStartMenuFolderTreeView', 'TStream', 'TStringList', 'TStrings', 'TStringStream',
-    'TSysLinkEvent', 'TSysLinkType', 'TUIStateForm', 'TUninstallProgressForm', 'TWinControl',
-    'TWizardForm', 'TWizardPage', 'TWizardPageButtonEvent', 'TWizardPageCancelEvent', 'TWizardPageNotifyEvent',
-    'TWizardPageShouldSkipEvent'
+    'TKeyPressEvent', 'TLabel', 'TLinkLabel', 'TListBox', 'TListBoxStyle', 'TMemo', 'TNewButton',
+    'TNewCheckBox', 'TNewCheckListBox', 'TNewComboBox', 'TNewEdit', 'TNewLinkLabel', 'TNewListBox',
+    'TNewMemo', 'TNewNotebook', 'TNewNotebookPage', 'TNewProgressBar', 'TNewProgressBarState',
+    'TNewProgressBarStyle', 'TNewRadioButton', 'TNewStaticText', 'TNotifyEvent', 'TObject',
+    'TOutputMarqueeProgressWizardPage', 'TOutputMsgMemoWizardPage', 'TOutputMsgWizardPage',
+    'TOutputProgressWizardPage', 'TPanel', 'TPanelBevel', 'TPasswordEdit', 'TPen', 'TPenMode',
+    'TPenStyle', 'TPersistent', 'TPosition', 'TRadioButton', 'TRichEditViewer', 'TScrollingWinControl',
+    'TScrollStyle', 'TSetupForm', 'TShiftState', 'TSizeConstraints', 'TStartMenuFolderTreeView',
+    'TStream', 'TStringList', 'TStrings', 'TStringStream', 'TSysLinkEvent', 'TSysLinkType',
+    'TUIStateForm', 'TUninstallProgressForm', 'TWinControl', 'TWizardForm', 'TWizardPage',
+    'TWizardPageButtonEvent', 'TWizardPageCancelEvent', 'TWizardPageNotifyEvent', 'TWizardPageShouldSkipEvent'
   ];
   ];
 
 
   PascalEnumValues_Isxclasses: array of AnsiString = [
   PascalEnumValues_Isxclasses: array of AnsiString = [
@@ -155,7 +154,6 @@ var
     'procedure SetProgress(Position, Max: Longint);',
     'procedure SetProgress(Position, Max: Longint);',
     'procedure SetText(Msg1, Msg2: String);',
     'procedure SetText(Msg1, Msg2: String);',
     'procedure Show;',
     'procedure Show;',
-    'procedure ShowAboutBox;',
     'procedure Sort;',
     'procedure Sort;',
     'procedure TextOut(X, Y: Integer; Text: String);',
     'procedure TextOut(X, Y: Integer; Text: String);',
     'procedure Update;',
     'procedure Update;',

+ 0 - 6
ISHelp/isxfunc.xml

@@ -268,12 +268,6 @@ end;</pre></example>
         <description><p>Returns the <tt>UninstallProgressForm</tt> support object, or raises an internal error if the object has not yet been created.</p></description>
         <description><p>Returns the <tt>UninstallProgressForm</tt> support object, or raises an internal error if the object has not yet been created.</p></description>
         <seealso><p><link topic="scriptclasses" anchor="UninstallProgressForm">UninstallProgressForm</link></p></seealso>
         <seealso><p><link topic="scriptclasses" anchor="UninstallProgressForm">UninstallProgressForm</link></p></seealso>
       </function>
       </function>
-      <function>
-        <name>GetMainForm</name>
-        <prototype>function GetMainForm: TMainForm;</prototype>
-        <description><p>Returns the <tt>MainForm</tt> support object, or raises an internal error if the object has not yet been created.</p></description>
-        <seealso><p><link topic="scriptclasses" anchor="MainForm">MainForm</link></p></seealso>
-      </function>
     </subcategory>
     </subcategory>
   </category>
   </category>
   <category>
   <category>