{
* This Source Code Form is subject to the terms of the Mozilla Public License,
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
* obtain one at http://mozilla.org/MPL/2.0/
*
* Copyright (C) 2005-2013, Peter Johnson (www.delphidabbler.com).
*
* $Rev$
* $Date$
*
* Implements the program's About dialogue box.
}
unit FmAboutDlg;
interface
uses
// Delphi
Forms, ComCtrls, StdCtrls, Controls, ExtCtrls, Classes, Messages,
// Project
Browser.UHTMLEvents, FmGenericViewDlg, FrBrowserBase, FrHTMLDlg,
FrHTMLTpltDlg, UCSSBuilder;
type
{
TPathInfoBox:
Component that displays a path in a group box with an associated button that
displays the path in Windows Explorer.
}
TPathInfoBox = class(TCustomGroupBox)
strict private
fPathLbl: TLabel; // Label that displays path
fViewBtn: TButton; // Button that displays path in explorer
function GetPath: string;
{Read accessor for Path property. Gets value from label.
@return Property value.
}
procedure SetPath(const Value: string);
{Write accessor for Path property. Stores value in label and updates state
of button.
@param Value [in] New property value.
}
procedure BtnClick(Sender: TObject);
{Button click event handler. Displays folder stored in Path property in
Windows Explorer.
@param Sender [in] Not used.
}
procedure FontChange(var Msg: TMessage); message CM_FONTCHANGED;
{Handles font changes by resizing control to allow for new font size.
@param Msg [in/out] Not used.
}
procedure ReArrange;
{Resizes and re-arranges control and its sub-components.
}
strict protected
procedure Resize; override;
{Handles control resizing. Re-arranges control's sub-components.
}
public
constructor Create(AOwner: TComponent); override;
{Component constructor. Creates sub-components and arranges them.
@param AOwner [in] Owning component.
}
property Path: string read GetPath write SetPath;
{Path displayed in group box and displayed by view button}
end;
{
TAboutDlg:
Implements an about dialog box displays information about the program and
provides access to the program's Easter egg.
}
TAboutDlg = class(TGenericViewDlg)
btnRegister: TButton;
bvlSeparator: TBevel;
frmProgram: THTMLTpltDlgFrame;
pcDetail: TPageControl;
tsProgram: TTabSheet;
pnlTitle: TPanel;
frmTitle: THTMLTpltDlgFrame;
tsPaths: TTabSheet;
procedure btnRegisterClick(Sender: TObject);
procedure FormCreate(Sender: TObject);
procedure FormDestroy(Sender: TObject);
/// <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 pcDetailMouseDown(Sender: TObject; Button: TMouseButton;
Shift: TShiftState; X, Y: Integer);
strict private
fUserDBPathGp: TPathInfoBox; // control that displays user database folder
fInstallPathGp: TPathInfoBox; // control that displays program install path
procedure HTMLEventHandler(Sender: TObject;
const EventInfo: THTMLEventInfo);
{Handles title frame's OnHTMLEvent event. Checks for easter-egg related
mouse events on icon image and acts accordingly.
@param Sender [in] Not used.
@param EventInfo [in] Object providing information about the event.
}
function RegistrationHTML: string;
{Builds HTML used to display registration information.
@return Required HTML.
}
strict protected
procedure ConfigForm; override;
{Configures form by creating custom controls and initialising HTML frames.
Called from ancestor class.
}
procedure InitForm; override;
{Initialises form's controls. Called from ancestor class.
}
procedure InitHTMLFrames;
{Initialises HTML frames to use required template document with
placeholders replaced by required values.
}
procedure ArrangeForm; override;
{Adjusts position of registration button on bottom button line. Called
from ancestor class.
}
procedure UpdateTitleCSS(Sender: TObject; const CSSBuilder: TCSSBuilder);
{Updates CSS used for HTML displayed in title frame.
@param Sender [in] Not used.
@param CSSBuilder [in] Object used to update CSS.
}
procedure UpdateDetailCSS(Sender: TObject; const CSSBuilder: TCSSBuilder);
{Updates CSS used for HTML displayed in HTML frame used to display program
description and credits.
@param Sender [in] Not used.
@param CSSBuilder [in] Object used to update CSS.
}
public
class procedure Execute(AOwner: TComponent);
{Displays dialog box.
@param AOwner [in] Component that owns this dialog box.
}
end;
implementation
uses
// Delphi
SysUtils, Graphics, Math, Windows, ShellAPI, IOUtils,
// Project
FmEasterEgg, FmRegistrationDlg, UAppInfo, UColours, UConsts, UCSSUtils,
UCtrlArranger, UFontHelper, UGraphicUtils, UHTMLUtils, UHTMLTemplate,
UResourceUtils, UThemesEx;
{
NOTE:
The about box uses three HTML templates. These are stored in RT_HTML resources
as:
+ "dlg-about-head-tplt.html"
+ "dlg-about-program-tplt.html"
+ "dlg-about-database-tplt.html".
The following placeholders are used in one or more of the templates. The
placeholders are replaced by their values within this unit:
<%Release%> program release number
<%ResURL%> url of programs HTML resources
<%Registered%> info about whether program is registered
<%ContribList%> list of program contributors
<%TesterList%> list of program testers
}
{$R *.dfm}
function ExploreFolder(const Folder: string): Boolean;
{Displays Windows Explorer showing a specified folder.
@param Folder [in] Folder to explore.
@return True if explorer displayed, False if not.
}
begin
if TDirectory.Exists(Folder) then
Result := ShellExecute(
0, 'explore', PChar(Folder), nil, nil, SW_SHOWNORMAL
) > 32
else
Result := False;
end;
{ TAboutDlg }
procedure TAboutDlg.ArrangeForm;
{Adjusts position of registration button on bottom button line. Called from
ancestor class.
}
var
PathTabHeight: Integer;
begin
fUserDBPathGp.Top := TCtrlArranger.BottomOf(fInstallPathGp, 8);
PathTabHeight := TCtrlArranger.BottomOf(fUserDBPathGp);
// Set height of title frame and page control
pnlTitle.Height := frmTitle.DocHeight;
pcDetail.ClientHeight :=
pcDetail.Height - tsProgram.ClientHeight
+ Max(PathTabHeight, frmProgram.DocHeight)
+ 8;
pnlBody.ClientHeight := pnlTitle.Height + bvlSeparator.Height +
pcDetail.Height;
inherited;
btnRegister.Left := pnlBody.Left;
btnRegister.Top := btnHelp.Top;
end;
procedure TAboutDlg.btnRegisterClick(Sender: TObject);
{Displays registration wizard when "Register CodeSnip" button is clicked.
@param Sender [in] Not used.
}
begin
if TRegistrationDlg.Execute(Self) then
btnRegister.Hide; // hide registration button now that program registered OK
end;
procedure TAboutDlg.ConfigForm;
{Configures form by creating custom controls and initialising HTML frames.
Called from ancestor class.
}
function CreatePathInfoBox(const Caption, Path: string): TPathInfoBox;
{Creates and initialises a custom path information control.
@param Caption [in] Group box caption.
@param Path [in] Path to be displayed.
@return New control.
}
begin
Result := TPathInfoBox.CreateParented(tsPaths.Handle);
Result.Parent := tsPaths;
Result.SetBounds(8, 8, tsPaths.ClientWidth - 16, 0);
Result.Caption := Caption;
Result.Path := Path;
end;
resourcestring
// Captions for custom controls
sInstallPathGpCaption = 'Install Directory';
sMainDBPathGpCaption = 'Main Database Directory';
sUserDBPathGpCaption = 'User Database Directory';
begin
inherited;
// Creates required custom controls
fInstallPathGp := CreatePathInfoBox(
sInstallPathGpCaption, TAppInfo.AppExeDir
);
fUserDBPathGp := CreatePathInfoBox(
sUserDBPathGpCaption, TAppInfo.UserDataDir
);
// Load content into HTML frames
InitHTMLFrames;
end;
class procedure TAboutDlg.Execute(AOwner: TComponent);
{Displays dialog box.
@param AOwner [in] Component that owns this dialog box.
}
begin
with Create(AOwner) do
try
ShowModal;
finally
Free;
end;
end;
procedure TAboutDlg.FormCreate(Sender: TObject);
{Form initialisation event handler. Sets handler that updates frame's CSS.
@param Sender [in] Not used.
}
begin
inherited;
frmTitle.OnBuildCSS := UpdateTitleCSS;
frmProgram.OnBuildCSS := UpdateDetailCSS;
end;
procedure TAboutDlg.FormDestroy(Sender: TObject);
{Form destruction event handler. Frees non-owned controls.
@param Sender [in] Not used.
}
begin
inherited;
fInstallPathGp.Free;
fUserDBPathGp.Free;
end;
procedure TAboutDlg.HTMLEventHandler(Sender: TObject;
const EventInfo: THTMLEventInfo);
{Handles title frame's OnHTMLEvent event. Checks for easter-egg related mouse
events on icon image and acts accordingly.
@param Sender [in] Not used.
@param EventInfo [in] Object providing information about the event.
}
const
cIconImgId = 'icon'; // id of icon image
begin
// Check for onclick event on icon tag: display easter egg if ctrl key
// pressed. Such an event is cancelled.
if EventInfo.IsEvent(
THTMLDocumentEvents2Sink.EventIntf,
THTMLDocumentEvents2Sink.DISPID_OnClick
)
and EventInfo.Args.ctrlKey
and EventInfo.ElemHasId(cIconImgId) then
begin
EventInfo.Cancelled := True;
TEasterEggForm.Execute(Self);
end;
// Check for mouse move over icon tag: change cursor to hand if ctrl key
// pressed to indicate clickable. Event permitted to bubble up.
if EventInfo.IsEvent(
THTMLDocumentEvents2Sink.EventIntf,
THTMLDocumentEvents2Sink.DISPID_OnMouseMove
)
and EventInfo.ElemHasId(cIconImgId) then
begin
if EventInfo.Args.ctrlKey then
EventInfo.Args.srcElement.style.cursor := 'hand'
else
EventInfo.Args.srcElement.style.cursor := 'auto';
end;
end;
procedure TAboutDlg.InitForm;
{Initialises form's controls.
}
begin
inherited;
// Decide whether to display register button
btnRegister.Visible := not TAppInfo.IsRegistered;
end;
procedure TAboutDlg.InitHTMLFrames;
{Initialises HTML frames to use required template document with placeholders
replaced by required values.
}
// ---------------------------------------------------------------------------
procedure InitTitleFrame;
{Initialises and loads HTML into title frame.
}
begin
frmTitle.Initialise(
'dlg-about-head-tplt.html',
procedure(Tplt: THTMLTemplate)
begin
Tplt.ResolvePlaceholderText('Release', TAppInfo.ProgramReleaseInfo);
// MakeResourceURL('') provides just URL part before resource name
Tplt.ResolvePlaceholderHTML('ResURL', MakeResourceURL(''));
end
);
frmTitle.OnHTMLEvent := HTMLEventHandler;
end;
procedure InitProgramFrame;
{Initialises and loads HTML into program frame.
}
begin
pcDetail.ActivePage := tsProgram; // display page to let browser load OK
frmProgram.Initialise(
'dlg-about-program-tplt.html',
procedure(Tplt: THTMLTemplate)
begin
Tplt.ResolvePlaceholderHTML('Registered', RegistrationHTML);
end
);
end;
// ---------------------------------------------------------------------------
begin
InitTitleFrame;
InitProgramFrame;
end;
procedure TAboutDlg.pcDetailMouseDown(Sender: TObject; Button: TMouseButton;
Shift: TShiftState; X, Y: Integer);
begin
if htOnItem in pcDetail.GetHitTestInfoAt(X, Y) then
pcDetail.SetFocus;
end;
function TAboutDlg.RegistrationHTML: string;
{Builds HTML used to display registration information.
@return Required HTML.
}
resourcestring
// Registration messages
sRegisteredMessage = 'Registered to %0:s.';
sUnregisteredMessage = 'Unregistered copy:';
sRegistrationPrompt = 'Please click the button below to register CodeSnip.';
var
SpanAttrs: IHTMLAttributes; // attributes of span tag
begin
if TAppInfo.IsRegistered then
Result := THTML.Entities(
Format(sRegisteredMessage, [TAppInfo.RegisteredUser])
)
else
begin
SpanAttrs := THTMLAttributes.Create('class', 'warning');
Result :=
THTML.CompoundTag(
'span', SpanAttrs, THTML.Entities(sUnregisteredMessage)
) +
THTML.Entities(' ' + sRegistrationPrompt);
end;
end;
procedure TAboutDlg.UpdateDetailCSS(Sender: TObject;
const CSSBuilder: TCSSBuilder);
{Updates CSS used for HTML displayed in detail (i.e. program and database)
frames.
@param Sender [in] Not used.
@param CSSBuilder [in] Object used to update CSS.
}
var
ContentFont: TFont; // font used for content
begin
// Modify body's margin and, for themed windows, background colour
with CSSBuilder.Selectors['body'] do
begin
ContentFont := TFont.Create;
try
TFontHelper.SetContentFont(ContentFont);
AddProperty(TCSS.FontProps(ContentFont));
if ThemeServicesEx.ThemesEnabled then
AddProperty(TCSS.BackgroundColorProp(ThemeServicesEx.GetTabBodyColour));
AddProperty(UCSSUtils.TCSS.MarginProp(0, 2, 6, 2));
finally
ContentFont.Free;
end;
end;
// Put border round scroll box
with CSSBuilder.AddSelector('.scrollbox') do
AddProperty(UCSSUtils.TCSS.BorderProp(cssAll, 1, cbsSolid, clBorder));
end;
procedure TAboutDlg.UpdateTitleCSS(Sender: TObject;
const CSSBuilder: TCSSBuilder);
{Updates CSS used for HTML displayed in title frame.
@param Sender [in] Not used.
@param CSSBuilder [in] Object used to update CSS.
}
begin
// Set body colour, and put border round it
with CSSBuilder.Selectors['body'] do
begin
AddProperty(TCSS.BackgroundColorProp(clWindow));
AddProperty(TCSS.PaddingProp(4));
end;
end;
{ TPathInfoBox }
procedure TPathInfoBox.BtnClick(Sender: TObject);
{Button click event handler. Displays folder stored in Path property in
Windows Explorer.
@param Sender [in] Not used.
}
begin
if Assigned(fPathLbl) and (fPathLbl.Caption <> '') then
ExploreFolder(fPathLbl.Caption);
end;
constructor TPathInfoBox.Create(AOwner: TComponent);
{Component constructor. Creates sub-components and arranges them.
@param AOwner [in] Owning component.
}
resourcestring
// Hint attached to view button
sViewBtnHint = 'Explore...|Display the path in Windows Explorer';
begin
inherited;
// Create and setup path label
fPathLbl := TLabel.Create(Self);
fPathLbl.Parent := Self;
fPathLbl.Left := 8;
fPathLbl.Top := 8;
fPathLbl.Width := 120;
fPathLbl.AutoSize := False;
fPathLbl.EllipsisPosition := epPathEllipsis;
fPathLbl.Width := Self.Width - 16;
fPathLbl.Caption := ' ';
fPathLbl.Transparent := True;
fPathLbl.ShowHint := True;
// Create and setup view button
fViewBtn := TButton.Create(Self);
fViewBtn.Parent := Self;
fViewBtn.OnClick := BtnClick;
fViewBtn.Height := 19;
fViewBtn.Width := 26;
fViewBtn.Caption := '...';
fViewBtn.Hint := sViewBtnHint;
fViewBtn.ShowHint := True;
// Ensure correct default font is used
TFontHelper.SetDefaultBaseFont(Font);
// Size and arrange controls
ReArrange;
end;
procedure TPathInfoBox.FontChange(var Msg: TMessage);
{Handles font changes by resizing control to allow for new font size.
@param Msg [in/out] Not used.
}
begin
inherited;
ReArrange;
end;
function TPathInfoBox.GetPath: string;
{Read accessor for Path property. Gets value from label.
@return Property value.
}
begin
Result := fPathLbl.Caption;
end;
procedure TPathInfoBox.ReArrange;
{Resizes and re-arranges control and its sub-components.
}
begin
TCtrlArranger.SetLabelHeight(fPathLbl);
Height := Max(fPathLbl.Height, fViewBtn.Height) + 24;
TCtrlArranger.AlignVCentres(
(ClientHeight - Max(fPathLbl.Height, fViewBtn.Height)) div 3 * 2,
[fPathLbl, fViewBtn]
);
fViewBtn.Left := ClientWidth - fViewBtn.Width - 8;
fPathLbl.Left := 8;
fPathLbl.Width := fViewBtn.Left - fPathLbl.Left - 8;
end;
procedure TPathInfoBox.Resize;
{Handles control resizing. Re-arranges control's sub-components.
}
begin
inherited;
ReArrange;
end;
procedure TPathInfoBox.SetPath(const Value: string);
{Write accessor for Path property. Stores value in label and updates state
of button.
@param Value [in] New property value.
}
resourcestring
// hints used when path doesn't exist
sShortPathDoesNotExist = 'Path does not exist';
sLongPathDoesNotExist = 'Path "%s"' + EOL + 'does not exist';
var
TextW: Integer; // width of full path name in label in pixels
begin
fPathLbl.Caption := Value;
TextW := StringExtent(Value, fPathLbl.Font).cx;
if TDirectory.Exists(Value) then
begin
if TextW > fPathLbl.Width then
// path will contain ellipsis in label: display full path as hint
fPathLbl.Hint := Value + '|' // pipe char makes this short (pop-up) hint
else
// path fully displayed in label: no hint
fPathLbl.Hint := '';
fViewBtn.Enabled := True;
end
else
begin
if TextW > fPathLbl.Width then
// path will contain ellipsis: display full path with message as hint
fPathLbl.Hint := Format(sLongPathDoesNotExist, [Value]) + '|'
else
// path fully displayed in label: don't include full path in hint
fPathLbl.Hint := sShortPathDoesNotExist;
fViewBtn.Enabled := False;
end;
end;
end.
