Merge branch 'feature/issue#7-customise-overiview-font-size' into develop

Author: delphidabbler

Docs/Design/FileFormats/config.html

@@ -913,6 +913,12 @@ <h4>
       The value is a definition of a custom colour in the format used by the <var>TColorDialog</var> dialogue box. This format is <code class="value">ColourID=ColourNum</code> where <em>ColourID</em> is a value from <code class="value">ColorA</code> to <code class="value">ColorP</code> and <em>ColourNum</em> is the hex representation of the colour.
     </div>
   </dd>
+  <dt>
+    <code class="key">OverviewFontSize</code> (Integer)
+  </dt>
+  <dd>
+    Size of font to be used in overview pane tree view. If missing or empty the default value is <code class="value">9</code>.
+  </dd>
 </dl>
 
 <h4>

Src/FrDisplayPrefs.dfm

@@ -32,6 +32,14 @@ inherited DisplayPrefsFrame: TDisplayPrefsFrame
     Height = 13
     Caption = 'Background colour for &source code:'
   end
+  object lblOverviewFontSize: TLabel
+    Left = 16
+    Top = 200
+    Width = 145
+    Height = 13
+    Caption = 'Overview tree view &font size: '
+    FocusControl = cbOverviewFontSize
+  end
   object cbOverviewTree: TComboBox
     Left = 192
     Top = 2
@@ -66,4 +74,12 @@ inherited DisplayPrefsFrame: TDisplayPrefsFrame
     TabOrder = 3
     OnClick = btnDefColoursClick
   end
+  object cbOverviewFontSize: TComboBox
+    Left = 192
+    Top = 197
+    Width = 57
+    Height = 21
+    TabOrder = 4
+    OnChange = cbOverviewFontSizeChange
+  end
 end

Src/FrDisplayPrefs.pas

@@ -34,12 +34,16 @@   TDisplayPrefsFrame = class(TPrefsBaseFrame)
     lblUserColour: TLabel;
     btnDefColours: TButton;
     lblSourceBGColour: TLabel;
+    lblOverviewFontSize: TLabel;
+    cbOverviewFontSize: TComboBox;
     procedure chkHideEmptySectionsClick(Sender: TObject);
     procedure btnDefColoursClick(Sender: TObject);
+    procedure cbOverviewFontSizeChange(Sender: TObject);
   strict private
     var
       ///  <summary>Flag indicating if changes affect UI.</summary>
       fUIChanged: Boolean;
+      fOverviewFontSize: Integer;
       fMainColourBox: TColorBoxEx;
       fMainColourDlg: TColorDialogEx;
       fUserColourBox: TColorBoxEx;
@@ -58,6 +62,7 @@   TDisplayPrefsFrame = class(TPrefsBaseFrame)
     function CreateCustomColourBox(const ColourDlg: TColorDialogEx):
       TColorBoxEx;
     procedure ColourBoxChangeHandler(Sender: TObject);
+    procedure PopulateFontSizeCombo;
   public
     constructor Create(AOwner: TComponent); override;
       {Class constructor. Sets up frame and populates controls.
@@ -97,14 +102,21 @@ implementation
 
 uses
   // Delphi
-  Math, Graphics, ExtCtrls,
+  SysUtils, Math, Graphics, ExtCtrls,
   // Project
-  FmPreferencesDlg, UColours, UCtrlArranger, UGraphicUtils;
+  FmPreferencesDlg, UColours, UCtrlArranger, UFontHelper, UGraphicUtils,
+  UMessageBox;
 
 
 {$R *.dfm}
 
 
+resourcestring
+  // Error messages
+  sErrBadOverviewFontSize   = 'Invalid font size';
+  sErrBadOverviewFontRange  = 'Font size out of range. '
+                              + 'Enter a value between %0:d and %1:d';
+
 { TDisplayPrefsFrame }
 
 procedure TDisplayPrefsFrame.Activate(const Prefs: IPreferences;
@@ -124,6 +136,8 @@ procedure TDisplayPrefsFrame.Activate(const Prefs: IPreferences;
   Prefs.DBHeadingCustomColours[False].CopyTo(fMainColourDlg.CustomColors, True);
   Prefs.DBHeadingCustomColours[True].CopyTo(fUserColourDlg.CustomColors, True);
   Prefs.SourceCodeBGCustomColours.CopyTo(fSourceBGColourDlg.CustomColors, True);
+  fOverviewFontSize := Prefs.OverviewFontSize;
+  cbOverviewFontSize.Text := IntToStr(fOverviewFontSize);
 end;
 
 procedure TDisplayPrefsFrame.ArrangeControls;
@@ -133,12 +147,16 @@ procedure TDisplayPrefsFrame.ArrangeControls;
   TCtrlArranger.AlignLefts(
     [
       lblOverviewTree, chkHideEmptySections, chkSnippetsInNewTab,
-      lblMainColour, lblUserColour, lblSourceBGColour, btnDefColours
+      lblMainColour, lblUserColour, lblSourceBGColour, btnDefColours,
+      lblOverviewFontSize
     ],
     0
   );
   TCtrlArranger.AlignLefts(
-    [cbOverviewTree, fMainColourBox, fUserColourBox, fSourceBGColourBox],
+    [
+      cbOverviewTree, fMainColourBox, fUserColourBox, fSourceBGColourBox,
+      cbOverviewFontSize
+    ],
     TCtrlArranger.RightOf(
       [lblOverviewTree, lblMainColour, lblUserColour, lblSourceBGColour],
       8
@@ -164,6 +182,10 @@ procedure TDisplayPrefsFrame.ArrangeControls;
   TCtrlArranger.MoveBelow(
     [lblSourceBGColour, fSourceBGColourBox], btnDefColours, 12
   );
+  TCtrlArranger.AlignVCentres(
+    TCtrlArranger.BottomOf(btnDefColours, 12),
+    [lblOverviewFontSize, cbOverviewFontSize]
+  );
   chkHideEmptySections.Width := Self.Width - 16;
   chkSnippetsInNewTab.Width := Self.Width - 16;
 end;
@@ -178,6 +200,43 @@ procedure TDisplayPrefsFrame.btnDefColoursClick(Sender: TObject);
   fUIChanged := True;
 end;
 
+procedure TDisplayPrefsFrame.cbOverviewFontSizeChange(Sender: TObject);
+var
+  Size: Integer;  // font size entered by user
+begin
+  inherited;
+  // Do nothing if combo box text field cleared
+  if cbOverviewFontSize.Text = '' then
+    Exit;
+  if TryStrToInt(cbOverviewFontSize.Text, Size) then
+  begin
+    if TFontHelper.IsInCommonFontSizeRange(Size) then
+    begin
+      // Combo has valid value entered: update
+      fOverviewFontSize := Size;
+      fUIChanged := True;
+    end
+    else
+    begin
+      // Font size out of range
+      TMessageBox.Error(
+        ParentForm,
+        Format(
+          sErrBadOverviewFontRange,
+          [TFontHelper.CommonFontSizes.Min, TFontHelper.CommonFontSizes.Max]
+        )
+      );
+      cbOverviewFontSize.Text := IntToStr(fOverviewFontSize);
+    end;
+  end
+  else
+  begin
+    // Combo has invalid value: say so
+    TMessageBox.Error(ParentForm, sErrBadOverviewFontSize);
+    cbOverviewFontSize.Text := IntToStr(fOverviewFontSize);
+  end;
+end;
+
 procedure TDisplayPrefsFrame.chkHideEmptySectionsClick(Sender: TObject);
   {Handles clicks on "Hide Empty Sections" check box. Flags UI preferences has
   having changed.
@@ -226,6 +285,8 @@ constructor TDisplayPrefsFrame.Create(AOwner: TComponent);
   fSourceBGColourBox := CreateCustomColourBox(fSourceBGColourDlg);
   fSourceBGColourBox.TabOrder := 5;
   lblSourceBGColour.FocusControl := fSourceBGColourBox;
+
+  PopulateFontSizeCombo;
 end;
 
 function TDisplayPrefsFrame.CreateCustomColourBox(
@@ -268,6 +329,7 @@ procedure TDisplayPrefsFrame.Deactivate(const Prefs: IPreferences);
   Prefs.SourceCodeBGCustomColours.CopyFrom(
     fSourceBGColourDlg.CustomColors, True
   );
+  Prefs.OverviewFontSize := StrToIntDef(cbOverviewFontSize.Text, 8);
 end;
 
 function TDisplayPrefsFrame.DisplayName: string;
@@ -309,6 +371,11 @@ function TDisplayPrefsFrame.OverviewTreeStateDesc(
   Result := cOTSStartStates[State];
 end;
 
+procedure TDisplayPrefsFrame.PopulateFontSizeCombo;
+begin
+  TFontHelper.ListCommonFontSizes(cbOverviewFontSize.Items);
+end;
+
 procedure TDisplayPrefsFrame.SelectOverviewTreeState(
   const State: TOverviewStartState);
   {Selects combo box item associated with a overview treeview startup state.

Src/FrHiliterPrefs.pas

@@ -131,8 +131,6 @@   THiliterPrefsFrame = class(TPrefsBaseFrame)
     ///  highlighter element.</summary>
     ///  <remarks>This RTF is used to display elememt in preview pane.</remarks>
     function GenerateRTF: TRTF;
-    ///  <summary>Returns reference to form that hosts the frame.</summary>
-    function ParentForm: TForm;
   public
     ///  <summary>Constructs frame instance and initialises controls.</summary>
     ///  <param name="AOwner">TComponent [in] Component that owns the frame.
@@ -217,6 +215,8 @@ implementation
 
   // Error messages
   sErrBadFontSize       = 'Invalid font size';
+  sErrBadFontRange      = 'Font size out of range. '
+                          + 'Enter a value between %0:d and %1:d';
 
 const
   ///  <summary>Map of highlighter elements to descriptions.</summary>
@@ -344,10 +344,24 @@ procedure THiliterPrefsFrame.cbFontSizeChange(Sender: TObject);
     Exit;
   if TryStrToInt(cbFontSize.Text, Size) then
   begin
-    // Combo has valid value entered: update
-    fAttrs.FontSize := Size;
-    UpdatePreview;
-    fChanged := True;
+    if TFontHelper.IsInCommonFontSizeRange(Size) then
+    begin
+      // Combo has valid value entered: update
+      fAttrs.FontSize := Size;
+      UpdatePreview;
+      fChanged := True;
+    end
+    else
+    begin
+      TMessageBox.Error(
+        ParentForm,
+        Format(
+          sErrBadFontRange,
+          [TFontHelper.CommonFontSizes.Min, TFontHelper.CommonFontSizes.Max]
+        )
+      );
+      cbFontSize.Text := IntToStr(fAttrs.FontSize);
+    end;
   end
   else
   begin
@@ -523,20 +537,6 @@ procedure THiliterPrefsFrame.miNamedStylesClick(Sender: TObject);
   UpdatePopupMenu;
 end;
 
-function THiliterPrefsFrame.ParentForm: TForm;
-var
-  ParentCtrl: TWinControl;  // reference to parent controls
-begin
-  // Loop through parent controls until form found or top level parent reached
-  ParentCtrl := Self.Parent;
-  while Assigned(ParentCtrl) and not (ParentCtrl is TForm) do
-    ParentCtrl := ParentCtrl.Parent;
-  if ParentCtrl is TForm then
-    Result := ParentCtrl as TForm
-  else
-    Result := nil;
-end;
-
 procedure THiliterPrefsFrame.PopulateElementsList;
 var
   ElemId: THiliteElement; // loops thru all highlighter elements

Src/FrPrefsBase.pas

@@ -41,6 +41,8 @@   TPrefsBaseFrame = class(TFrame)
   strict protected
     class function IsFlagSupported(const Flag: UInt64): Boolean; inline;
     class function ExtractFrameFlag(const Flag: UInt64): UInt32; inline;
+    ///  <summary>Returns reference to form that hosts the frame.</summary>
+    function ParentForm: TForm;
   public
     procedure SavePrefs(const Prefs: IPreferences); virtual;
       {Saves information user entered in frame. By default the method simply
@@ -90,7 +92,8 @@ implementation
 
 uses
   // Delphi
-  SysUtils;
+  SysUtils,
+  Controls;
 
 
 {$R *.dfm}
@@ -127,6 +130,20 @@ class function TPrefsBaseFrame.MakeFrameFlag(const Flag: UInt32): UInt64;
   Int64Rec(Result).Lo := Flag;
 end;
 
+function TPrefsBaseFrame.ParentForm: TForm;
+var
+  ParentCtrl: TWinControl;  // reference to parent controls
+begin
+  // Loop through parent controls until form found or top level parent reached
+  ParentCtrl := Self.Parent;
+  while Assigned(ParentCtrl) and not (ParentCtrl is TForm) do
+    ParentCtrl := ParentCtrl.Parent;
+  if ParentCtrl is TForm then
+    Result := ParentCtrl as TForm
+  else
+    Result := nil;
+end;
+
 procedure TPrefsBaseFrame.SavePrefs(const Prefs: IPreferences);
   {Saves information user entered in frame. By default the method simply calls
   Deactivate. May be overridden to save any custom data that doesn't use Prefs

Src/Help/HTML/dlg_prefs_display.htm

@@ -60,8 +60,8 @@ <h1>
         Choose whether empty section headings are hidden in the <a
           href="overview_pane.htm"
         >overview pane</a>. Check the <em>Hide empty section headings in
-        overview</em> check box to hide empty section headings or clear the check
-        box to display them.
+        overview</em> check box to hide empty section headings or clear the
+        check box to display them.
       </li>
       <li>
         <p>
@@ -91,6 +91,12 @@ <h1>
           by clicking the <em>Use Default Colours</em> button.
         </p>
       </li>
+      <li>
+        Choose the size of font used in the <a
+          href="overview_pane.htm"
+        >overview pane</a>'s tree view using the <em>Overview tree font
+        size</em> combo box.
+      </li>
     </ul>
   </body>
 </html>

Src/UFontHelper.pas

@@ -19,7 +19,7 @@ interface
   // Delphi
   Classes, Graphics,
   // Project
-  UBaseObjects;
+  UBaseObjects, UStructs;
 
 
 type
@@ -45,6 +45,11 @@   TFontHelper = class(TNoConstructObject)
         @param List [in] Receives list of font sizes. Cleared before sizes
           added.
       }
+    ///  <summary>Checks if given font size falls within range of common font
+    ///  sizes.</summary>
+    ///  <remarks>Common font size range is between smallest and largest font
+    ///  sizes returned by ListCommonFontSizes method.</remarks>
+    class function IsInCommonFontSizeRange(const FontSize: Integer): Boolean;
     class procedure SetDefaultFont(const Font: TFont);
       {Sets a font to be the default UI font for the underlying operating
       system.
@@ -92,6 +97,11 @@   TFontHelper = class(TNoConstructObject)
 
       DefaultMonoFontName = 'Courier New';        // Default mono font name
       DefaultMonoFontSize = 8;                    // Default mono font size
+
+  public
+    const
+      // Range of common font sizes
+      CommonFontSizes: TRange = (Min: 7; Max: 32);
   end;
 
 
@@ -148,6 +158,12 @@ class function TFontHelper.FontExists(const FontName: string): Boolean;
   Result := Screen.Fonts.IndexOf(FontName) >= 0;
 end;
 
+class function TFontHelper.IsInCommonFontSizeRange(
+  const FontSize: Integer): Boolean;
+begin
+  Result := CommonFontSizes.Contains(FontSize);
+end;
+
 class procedure TFontHelper.ListCommonFontSizes(const List: TStrings);
   {Lists all commonly used font sizes.
     @param List [in] Receives list of font sizes. Cleared before sizes added.
@@ -157,7 +173,7 @@ class procedure TFontHelper.ListCommonFontSizes(const List: TStrings);
 begin
   Assert(Assigned(List), ClassName + '.ListCommonFontSizes: List is nil');
   List.Clear;
-  for FontSize := 7 to 32 do
+  for FontSize := CommonFontSizes.Min to CommonFontSizes.Max do
     List.Add(IntToStr(FontSize));
 end;