Unit Utils.Templates

Description
Classes, Interfaces, Objects and Records
Functions and Procedures
Types

Description

Unit which has the app templates used by pasc new –template. A template is a set of files embedded as resources, written to the app folder with the app name in place of {APPNAME}, and the boss dependencies the app needs.

Overview

Classes, Interfaces, Objects and Records

Name Description
Record TTemplateFile A file of a template: the resource with its content and the path where it is written, relative to the app folder, with / as separator and {APPNAME} in place of the app name.
Record TTemplate An app template.

Functions and Procedures

function GetTemplates: TTemplates;
function FindTemplate(const AName: string; out ATemplate: TTemplate): Boolean;
function GetTemplateNames: string;
function WriteTemplateFiles(const ATemplate: TTemplate; const AAppDir, AAppName: string): TArray<string>;

Types

TTemplates = TArray<TTemplate>;

Description

Functions and Procedures

function GetTemplates: TTemplates;

Returns the available templates.

function FindTemplate(const AName: string; out ATemplate: TTemplate): Boolean;

Finds a template by its name, ignoring case. Returns false if there is none.

Parameters
AName
Template name.
ATemplate
Returns the template found.
function GetTemplateNames: string;

Returns the names of the available templates, separated by commas.

function WriteTemplateFiles(const ATemplate: TTemplate; const AAppDir, AAppName: string): TArray<string>;

Writes the files of the template to the app folder, creating the subfolders, with the app name in place of {APPNAME}. Returns the files written.

Parameters
ATemplate
Template whose files are written.
AAppDir
App folder.
AAppName
App name.

Types

TTemplates = TArray<TTemplate>;

This item has no description.

Generated by PasDoc 1.0.4.