Merge branch 'feature/issue#13&#24-prefs-dlg' into develop

Author: delphidabbler

Docs/Design/FileFormats/config.html

@@ -732,6 +732,27 @@ <h4>
   </dd>
 </dl>
 
+<h4>
+  [Prefs] section
+</h4>
+
+<p>
+  Stores information about the Preferences dialogue box itself, rather than actual preferences data. Actual preference data is stored in sections with names like [Prefs:XXX] where XXX is a preferences sub-section.
+</p>
+
+<p>
+  Name / Value pairs:
+</p>
+
+<dl class="indent">
+  <dt>
+    <code class="key">LastTab</code> (string)
+  </dt>
+  <dd>
+    Name of the tab that was open when the dialogue box was last closed. May be the empty string if the dialogue box has not yet been opened.
+  </dd>
+</dl>
+
 <h4>
   [Prefs:CodeGen] section
 </h4>

Src/FmPreferencesDlg.dfm

@@ -3,27 +3,37 @@ inherited PreferencesDlg: TPreferencesDlg
   Top = 138
   Caption = 'Preferences'
   ClientHeight = 421
-  ClientWidth = 462
-  ExplicitWidth = 468
-  ExplicitHeight = 447
+  ClientWidth = 722
+  ExplicitWidth = 728
+  ExplicitHeight = 450
   PixelsPerInch = 96
   TextHeight = 13
   inherited pnlBody: TPanel
-    Width = 446
-    Height = 377
-    ExplicitWidth = 446
-    ExplicitHeight = 377
+    Width = 609
+    Height = 329
+    ExplicitWidth = 609
+    ExplicitHeight = 329
     object pcMain: TPageControl
-      Left = 0
+      Left = 163
       Top = 0
       Width = 446
-      Height = 377
-      Align = alClient
+      Height = 329
+      Align = alRight
       MultiLine = True
+      TabOrder = 1
+      ExplicitLeft = 159
+      ExplicitHeight = 377
+    end
+    object lbPages: TListBox
+      Left = 0
+      Top = 0
+      Width = 153
+      Height = 329
+      Align = alLeft
+      ItemHeight = 13
       TabOrder = 0
-      OnChange = pcMainChange
-      OnChanging = pcMainChanging
-      OnMouseDown = pcMainMouseDown
+      OnClick = lbPagesClick
+      ExplicitHeight = 377
     end
   end
   inherited btnOK: TButton

Src/FmPreferencesDlg.pas

@@ -32,26 +32,14 @@ interface
   ///  </remarks>
   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
     pcMain: TPageControl;
+    lbPages: TListBox;
     ///  <summary>OK button click event handler. Writes preference data to
     ///  persistent storage.</summary>
     procedure btnOKClick(Sender: TObject);
-    ///  <param>Called when current tab sheet has changed. Gets newly selected
-    ///  page to re-initialise its controls from local preferences.</param>
-    ///  <remarks>This enables any pages that depend on preferences that may
-    ///  have been changed in other pages to update appropriately.</remarks>
-    procedure pcMainChange(Sender: TObject);
-    ///  <summary>Called just before active tab sheet is changed. Causes page
-    ///  about to be deselected to update local preferences with any changes.
-    ///  </summary>
-    ///  <remarks>We do this in case another page needs to update due to changes
-    ///  made on current page.</remarks>
-    procedure pcMainChanging(Sender: TObject; var AllowChange: Boolean);
-    ///  <summary>Handles event triggered when user clicks on one of page
-    ///  control tabs. Ensures page control has focus.</summary>
-    ///  <remarks>Without this fix, page control does not always get focus when
-    ///  a tab is clicked.</remarks>
-    procedure pcMainMouseDown(Sender: TObject; Button: TMouseButton;
-      Shift: TShiftState; X, Y: Integer);
+    ///  <summary>Handles event triggered when list box is clicked or changed
+    ///  via keyboard.</summary>
+    procedure lbPagesClick(Sender: TObject);
+    procedure FormDestroy(Sender: TObject);
   strict private
     class var
       ///  <summary>List of registered page frames</summary>
@@ -62,6 +50,10 @@   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
       ///  <summary>Records if main UI needs to be updated to reflect changed
       ///  preferences.</summary>
       fUpdateUI: Boolean;
+      ///  <summary>Records flags to be passed to frames.</summary>
+      fFrameFlags: UInt64;
+      ///  <summary>Records index of currently select tab/list item.</summary>
+      fCurrentPageIdx: Integer;
     ///  <summary>Creates the required frames and displays each in a tab sheet
     ///  within the page control.</summary>
     ///  <param name="FrameClasses">array of TPrefsFrameClass [in] Class
@@ -83,6 +75,13 @@   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
     ///  <summary>Gets reference to preferences frame on currently selected tab.
     ///  </summary>
     function GetSelectedPage: TPrefsBaseFrame;
+    ///  <summary>Selects given tab.</summary>
+    ///  <remarks>Stores state of tab being closed and restores state of tab
+    ///  being opened.</remarks>
+    procedure SelectTab(TS: TTabSheet);
+    ///  <summary>Returns index of tab selected when dialogue box was last
+    ///  closed or -1 if no tab recorded or tab doesn't exist.</summary>
+    function GetLastTabIdx: Integer;
   strict protected
     ///  <summary>Gets the help A-link keyword to be used when help button
     ///  clicked.</summary>
@@ -111,7 +110,8 @@   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
     ///  <returns>Boolean. True if user clicks OK to accept changes or False if
     ///  user cancels and no changes made.</returns>
     class function Execute(AOwner: TComponent;
-      const Pages: array of TPrefsFrameClass; out UpdateUI: Boolean): Boolean;
+      const Pages: array of TPrefsFrameClass; out UpdateUI: Boolean;
+      const Flags: UInt64 = 0): Boolean;
       overload;
     ///  <summary>Displays dialog with pages for each specified preferences
     ///  frame.</summary>
@@ -122,7 +122,8 @@   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
     ///  <returns>Boolean. True if user clicks OK to accept changes or False if
     ///  user cancels and no changes made.</returns>
     class function Execute(AOwner: TComponent;
-      const Pages: array of TPrefsFrameClass): Boolean; overload;
+      const Pages: array of TPrefsFrameClass; const Flags: UInt64 = 0):
+      Boolean; overload;
     ///  <summary>Displays preferences dialog with all registered preference
     ///  frames.</summary>
     ///  <param name="AOwner">TComponent [in] Component that owns dialog.
@@ -131,8 +132,8 @@   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
     ///  be updated as a result of preference changes.</param>
     ///  <returns>Boolean. True if user clicks OK to accept changes or False if
     ///  user cancels and no changes made.</returns>
-    class function Execute(AOwner: TComponent; out UpdateUI: Boolean): Boolean;
-      overload;
+    class function Execute(AOwner: TComponent; out UpdateUI: Boolean;
+      const Flags: UInt64 = 0): Boolean; overload;
     ///  <summary>Displays dialogue with showing a single frame, specified by
     ///  its class name.</summary>
     ///  <param name="AOwner">TComponent [in] Component that owns dialog.
@@ -144,7 +145,7 @@   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
     ///  <returns>Boolean. True if user clicks OK to accept changes or False if
     ///  user cancels and no changes made.</returns>
     class function Execute(AOwner: TComponent; const PageClsName: string;
-      out UpdateUI: Boolean): Boolean; overload;
+      out UpdateUI: Boolean; const Flags: UInt64 = 0): Boolean; overload;
     ///  <summary>Registers given preferences frame class for inclusion in the
     ///  preferences dialog box.</summary>
     ///  <remarks>Registered frames are created when the dialog box is displayed
@@ -177,7 +178,8 @@ implementation
 
 uses
   // Project
-  IntfCommon;
+  IntfCommon,
+  UStrUtils;
 
 
 {$R *.dfm}
@@ -241,6 +243,10 @@ procedure TPreferencesDlg.CreatePages(
     Frame.Top := 4;
     // set tab sheet caption to frame's display name
     TS.Caption := Frame.DisplayName;
+    TS.TabVisible := False;
+
+    // Create list box item for page
+    lbPages.Items.AddObject(Frame.DisplayName, TS);
   end;
 end;
 
@@ -256,10 +262,12 @@ function TPreferencesDlg.CustomHelpKeyword: string;
 end;
 
 class function TPreferencesDlg.Execute(AOwner: TComponent;
-  const Pages: array of TPrefsFrameClass; out UpdateUI: Boolean): Boolean;
+  const Pages: array of TPrefsFrameClass; out UpdateUI: Boolean;
+  const Flags: UInt64): Boolean;
 begin
   with InternalCreate(AOwner) do
     try
+      fFrameFlags := Flags;
       CreatePages(Pages);
       Result := ShowModal = mrOK;
       if Result then
@@ -272,21 +280,22 @@ class function TPreferencesDlg.Execute(AOwner: TComponent;
 end;
 
 class function TPreferencesDlg.Execute(AOwner: TComponent;
-  out UpdateUI: Boolean): Boolean;
+  out UpdateUI: Boolean; const Flags: UInt64): Boolean;
 begin
-  Result := Execute(AOwner, fPages.ToArray, UpdateUI);
+  Result := Execute(AOwner, fPages.ToArray, UpdateUI, Flags);
 end;
 
 class function TPreferencesDlg.Execute(AOwner: TComponent;
-  const Pages: array of TPrefsFrameClass): Boolean;
+  const Pages: array of TPrefsFrameClass; const Flags: UInt64): Boolean;
 var
   Dummy: Boolean; // unused UpdateUI parameters
 begin
-  Result := Execute(AOwner, Pages, Dummy);
+  Result := Execute(AOwner, Pages, Dummy, Flags);
 end;
 
 class function TPreferencesDlg.Execute(AOwner: TComponent;
-  const PageClsName: string; out UpdateUI: Boolean): Boolean;
+  const PageClsName: string; out UpdateUI: Boolean; const Flags: UInt64):
+  Boolean;
 var
   FrameClass: TPrefsFrameClass;
 begin
@@ -295,14 +304,36 @@ class function TPreferencesDlg.Execute(AOwner: TComponent;
   Result := Execute(AOwner, [FrameClass], UpdateUI);
 end;
 
+procedure TPreferencesDlg.FormDestroy(Sender: TObject);
+begin
+  // Save current tab
+  if Assigned(pcMain.ActivePage) then
+    Preferences.LastTab := MapTabSheetToPage(pcMain.ActivePage).DisplayName;
+  inherited;
+end;
+
+function TPreferencesDlg.GetLastTabIdx: Integer;
+var
+  TabName: string;
+  ListIdx: Integer;
+begin
+  TabName := Preferences.LastTab;
+  if TabName = '' then
+    Exit(-1);
+  for ListIdx := 0 to Pred(lbPages.Count) do
+    if StrSameText(TabName, lbPages.Items[ListIdx]) then
+      Exit(ListIdx);
+  Result := -1;
+end;
+
 function TPreferencesDlg.GetSelectedPage: TPrefsBaseFrame;
 begin
   Result := MapTabSheetToPage(pcMain.ActivePage);
 end;
 
 procedure TPreferencesDlg.InitForm;
 var
-  TabIdx: Integer;  // loops thru tabs in page control
+  TabIdx: Integer;      // loops thru tabs in page control
 begin
   inherited;
   // Take local copy of global preferences. This local copy will be updated as
@@ -311,9 +342,22 @@ procedure TPreferencesDlg.InitForm;
   fLocalPrefs := (Preferences as IClonable).Clone as IPreferences;
   // Display and initialise required pages
   for TabIdx := 0 to Pred(pcMain.PageCount) do
-    MapTabSheetToPage(TabIdx).LoadPrefs(fLocalPrefs);
-  // Select first TabSheet
-  pcMain.ActivePageIndex := 0;
+    MapTabSheetToPage(TabIdx).LoadPrefs(fLocalPrefs, fFrameFlags);
+  // Select last use tab sheet (or 1st if last not known)
+  fCurrentPageIdx := GetLastTabIdx;
+  if fCurrentPageIdx < 0 then
+    fCurrentPageIdx := 0;
+  pcMain.ActivePageIndex := fCurrentPageIdx;
+  lbPages.ItemIndex := fCurrentPageIdx;
+end;
+
+procedure TPreferencesDlg.lbPagesClick(Sender: TObject);
+begin
+  if lbPages.ItemIndex < 0 then
+    Exit;
+  if lbPages.ItemIndex = fCurrentPageIdx then
+    Exit;
+  SelectTab(lbPages.Items.Objects[lbPages.ItemIndex] as TTabSheet)
 end;
 
 class function TPreferencesDlg.MapClassNameToPageClass(const ClsName: string):
@@ -351,24 +395,6 @@ function TPreferencesDlg.MapTabSheetToPage(
   Assert(Assigned(Result), ClassName + '.MapTabSheetToPage: Frame not found');
 end;
 
-procedure TPreferencesDlg.pcMainChange(Sender: TObject);
-begin
-  GetSelectedPage.Activate(fLocalPrefs);
-end;
-
-procedure TPreferencesDlg.pcMainChanging(Sender: TObject;
-  var AllowChange: Boolean);
-begin
-  GetSelectedPage.Deactivate(fLocalPrefs);
-end;
-
-procedure TPreferencesDlg.pcMainMouseDown(Sender: TObject; Button: TMouseButton;
-  Shift: TShiftState; X, Y: Integer);
-begin
-  if htOnItem in pcMain.GetHitTestInfoAt(X, Y) then
-    pcMain.SetFocus;
-end;
-
 class procedure TPreferencesDlg.RegisterPage(const FrameCls: TPrefsFrameClass);
 var
   PageIdx: Integer; // loops through all registered frames
@@ -389,5 +415,14 @@ class procedure TPreferencesDlg.RegisterPage(const FrameCls: TPrefsFrameClass);
   fPages.Insert(InsIdx, FrameCls);
 end;
 
+procedure TPreferencesDlg.SelectTab(TS: TTabSheet);
+begin
+  Assert(Assigned(TS), ClassName + '.SelectTab: TS is nil');
+  GetSelectedPage.Deactivate(fLocalPrefs);
+  pcMain.ActivePage := TS;
+  GetSelectedPage.Activate(fLocalPrefs, fFrameFlags);
+  fCurrentPageIdx := pcMain.ActivePageIndex;
+end;
+
 end.
 

Src/FmPrintDlg.pas

@@ -130,7 +130,11 @@ procedure TPrintDlg.btnPrefencesClick(Sender: TObject);
   sMessage = 'Your preferences will take effect the next time you start the '
     + 'application';
 begin
-  if TPreferencesDlg.Execute(Self, [TPrintingPrefsFrame]) then
+  if TPreferencesDlg.Execute(
+    Self,
+    [TPrintingPrefsFrame],
+    TPrintingPrefsFrame.MakeFrameFlag(TPrintingPrefsFrame.HideRestartMessage)
+  ) then
   begin
     if TMessageBox.Confirm(Self, sQuery) then
     begin

Src/FrCodeGenPrefs.pas

@@ -176,7 +176,8 @@   TCodeGenPrefsFrame = class(TPrefsBaseFrame)
     ///  <summary>Records details of warnings from given preferences object and
     ///  updates controls accordingly.</summary>
     ///  <remarks>Called when page is activated.</remarks>
-    procedure Activate(const Prefs: IPreferences); override;
+    procedure Activate(const Prefs: IPreferences; const Flags: UInt64);
+      override;
     ///  <summary>Updates given preferences object with details of warnings as
     ///  modified by user.</summary>
     ///  <remarks>Called when page is deactivated.</remarks>
@@ -322,7 +323,8 @@ procedure TCodeGenPrefsFrame.actDeleteUpdate(Sender: TObject);
   actDelete.Enabled := Assigned(fLVWarnings.Selected);
 end;
 
-procedure TCodeGenPrefsFrame.Activate(const Prefs: IPreferences);
+procedure TCodeGenPrefsFrame.Activate(const Prefs: IPreferences;
+  const Flags: UInt64);
 begin
   (fWarnings as IAssignable).Assign(Prefs.Warnings);
   chkWARNEnabled.Checked := fWarnings.Enabled;

Src/FrDisplayPrefs.pas

@@ -63,7 +63,8 @@   TDisplayPrefsFrame = class(TPrefsBaseFrame)
       {Class constructor. Sets up frame and populates controls.
         @param AOwner [in] Component that owns frame.
       }
-    procedure Activate(const Prefs: IPreferences); override;
+    procedure Activate(const Prefs: IPreferences; const Flags: UInt64);
+      override;
       {Called when page activated. Updates controls.
         @param Prefs [in] Object that provides info used to update controls.
       }
@@ -106,7 +107,8 @@ implementation
 
 { TDisplayPrefsFrame }
 
-procedure TDisplayPrefsFrame.Activate(const Prefs: IPreferences);
+procedure TDisplayPrefsFrame.Activate(const Prefs: IPreferences;
+  const Flags: UInt64);
   {Called when page activated. Updates controls.
     @param Prefs [in] Object that provides info used to update controls.
   }