{
* UDialogMgr.pas
*
* Implements class that manages the display of dialog boxes.
*
* $Rev$
* $Date$
*
* ***** BEGIN LICENSE BLOCK *****
*
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The Original Code is UDialogMgr.pas
*
* The Initial Developer of the Original Code is Peter Johnson
* (http://www.delphidabbler.com/).
*
* Portions created by the Initial Developer are Copyright (C) 2007-2010 Peter
* Johnson. All Rights Reserved.
*
* Contributor(s)
* NONE
*
* ***** END LICENSE BLOCK *****
}
unit UDialogMgr;
interface
uses
// Delphi
Classes,
// Project
USearch, USnippets;
type
{
TDialogMgr:
Class that manages the display of dialog boxes. Has Owner property that is
supplied to each dialog box as it is displayed.
}
TDialogMgr = class(TComponent)
public
procedure ShowAboutDlg;
{Displays About box.
}
procedure ShowBugReportDlg;
{Displays Bug Report dialog box.
}
function ExecFindCompilerDlg(out ASearch: ISearch): Boolean;
{Displays Find Compiler dialog box.
@param ASearch [out] Set to object recording search details if user OKs.
@return True if user OKs or false if user cancels.
}
function ExecFindTextDlg(out ASearch: ISearch): Boolean;
{Displays Find Text dialog box.
@param ASearch [out] Set to object recording search details if user OKs.
@return True if user OKs or false if user cancels.
}
function ExecFindXRefsDlg(const ARoutine: TRoutine;
out ASearch: ISearch): Boolean;
{Displays Find Cross References dialog box.
@param ARoutine [in] Snippet for which Cross-references are required.
@param ASearch [out] Set to object recording search details if user OKs.
@return True if user OKs or false if user cancels.
}
function ExecPreferencesDlg: Boolean;
{Display Preferences dialog box.
@return True if user OKs and preferences are updated or False if
cancelled.
}
function ExecRegistrationDlg: Boolean;
{Displays Registration dialog box.
@return True if program was registered and False if not.
}
function ExecSelectionSearchDlg(const SelectedRoutines: TRoutineList;
out ASearch: ISearch): Boolean;
{Displays Select Snippets dialog box.
@param SelectedRoutines [in] Default list of selected snippets.
@param ASearch [out] Search to be performed if user OKs.
@return True if user OKs or false if user cancels.
}
function ExecUpdateDlg: Boolean;
{Displays Update From Web dialog box.
@return True if database updated succesfully or false if database up to
date, update failed or user cancelled.
}
function ExecPrintDlg: Boolean;
{Displays Print dialog box.
@return True if user OKs, False if cancelled.
}
function ExecPageSetupDlg: Boolean;
{Displays Page Setup dialog box. Records page setup in persistent storage
if user OKs.
@return True if user OKs, False if cancelled.
}
procedure ShowDonateDlg;
{Displays Donate dialog box.
}
procedure ShowTestUnit(const Snippet: TRoutine);
{Displays test unit used to test compile a snippet.
@param Snippet [in] Snippet to be test compiled.
}
procedure ShowDependencyTree(const Snippet: TRoutine);
{Displays dependency tree for a snippet.
@param Snippet [in] Snippet for which dependency tree is required.
}
function ExecProxyServerDlg: Boolean;
{Displays Proxy Server configuration dialog box.
@return True if user OKs or False if user cancels.
}
procedure ShowNewsDlg;
{Displays latest news about CodeSnip and database in a dialog box.
}
end;
implementation
uses
// Project
FmAboutDlg, FmDependenciesDlg, FmDonateDlg, FmFindCompilerDlg, FmFindTextDlg,
FmFindXRefsDlg, FmNewsDlg, FmPreferencesDlg, FmPrintDlg, FmProxyServerDlg,
FmRegistrationDlg, FmSelectionSearchDlg, FmUpdateDlg, FmUserBugReportDlg,
UPageSetupDlgMgr, UTestUnitDlgMgr;
{ TDialogMgr }
function TDialogMgr.ExecFindCompilerDlg(out ASearch: ISearch): Boolean;
{Displays Find Compiler dialog box.
@param ASearch [out] Set to object recording search details if user OKs.
@return True if user OKs or false if user cancels.
}
begin
Result := TFindCompilerDlg.Execute(Owner, ASearch);
end;
function TDialogMgr.ExecFindTextDlg(out ASearch: ISearch): Boolean;
{Displays Find Text dialog box.
@param ASearch [out] Set to object recording search details if user OKs.
@return True if user OKs or false if user cancels.
}
begin
Result := TFindTextDlg.Execute(Owner, ASearch);
end;
function TDialogMgr.ExecFindXRefsDlg(const ARoutine: TRoutine;
out ASearch: ISearch): Boolean;
{Displays Find Cross References dialog box.
@param ARoutine [in] Snippet for which Cross-references are required.
@param ASearch [out] Set to object recording search details if user OKs.
@return True if user OKs or false if user cancels.
}
begin
Result := TFindXRefsDlg.Execute(Owner, ARoutine, ASearch);
end;
function TDialogMgr.ExecPageSetupDlg: Boolean;
{Displays Page Setup dialog box. Records page setup in persistent storage if
user OKs.
@return True if user OKs, False if cancelled.
}
begin
Result := TPageSetupDlgMgr.Execute(Owner);
end;
function TDialogMgr.ExecPreferencesDlg: Boolean;
{Display Preferences dialog box.
@return True if user OKs and preferences are updated or False if cancelled.
}
begin
Result := TPreferencesDlg.Execute(Owner);
end;
function TDialogMgr.ExecPrintDlg: Boolean;
{Displays Print dialog box.
@return True if user OKs, False if cancelled.
}
begin
Result := TPrintDlg.Execute(Owner);
end;
function TDialogMgr.ExecProxyServerDlg: Boolean;
{Displays Proxy Server configuration dialog box.
@return True if user OKs or False if user cancels.
}
begin
Result := TProxyServerDlg.Execute(Owner);
end;
function TDialogMgr.ExecRegistrationDlg: Boolean;
{Displays Registration dialog box.
@return True if program was registered and False if not.
}
begin
Result := TRegistrationDlg.Execute(Owner);
end;
function TDialogMgr.ExecSelectionSearchDlg(
const SelectedRoutines: TRoutineList; out ASearch: ISearch): Boolean;
{Displays Select Snippets dialog box.
@param SelectedRoutines [in] Default list of selected snippets.
@param ASearch [out] Search to be performed if user OKs.
@return True if user OKs or false if user cancels.
}
begin
Result := TSelectionSearchDlg.Execute(Owner, SelectedRoutines, ASearch);
end;
function TDialogMgr.ExecUpdateDlg: Boolean;
{Displays Update From Web dialog box.
@return True if database updated succesfully or false if database up to
date, update failed or user cancelled.
}
begin
Result := TUpdateDlg.Execute(Owner);
end;
procedure TDialogMgr.ShowAboutDlg;
{Displays About box.
}
begin
TAboutDlg.Execute(Owner);
end;
procedure TDialogMgr.ShowBugReportDlg;
{Displays Bug Report dialog box.
}
begin
TUserBugReportDlg.Execute(Owner);
end;
procedure TDialogMgr.ShowDependencyTree(const Snippet: TRoutine);
{Displays dependency tree for a snippet.
@param Snippet [in] Snippet for which dependency tree is required.
}
begin
TDependenciesDlg.Execute(Owner, Snippet);
end;
procedure TDialogMgr.ShowDonateDlg;
{Displays Donate dialog box.
}
begin
TDonateDlg.Execute(Owner);
end;
procedure TDialogMgr.ShowNewsDlg;
{Displays latest news about CodeSnip and database in a dialog box.
}
begin
TNewsDlg.Execute(Owner);
end;
procedure TDialogMgr.ShowTestUnit(const Snippet: TRoutine);
{Displays test unit used to test compile a snippet.
@param Snippet [in] Snippet to be test compiled.
}
begin
TTestUnitDlgMgr.DisplayTestUnit(Owner, Snippet);
end;
end.
