Class TExternalItem

Fields

Unit

Declaration

type TExternalItem = class(TBaseItem)

Description

TExternalItem extends TBaseItem to store extra information about a project. TExternalItem is used to hold an introduction and conclusion to the project.

Hierarchy

TObject
TSerializable
TBaseItem
TExternalItem

Overview

Methods

	`procedure HandleTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);`
	`procedure HandleShortTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);`
	`Constructor Create; override;`
	`destructor Destroy; override;`
	`procedure RegisterTags(TagManager: TTagManager); override;`
	`function FindItem(const ItemName: string): TBaseItem; override;`
	`procedure AddAnchor(const AnchorItem: TAnchorItem); overload;`
	`function AddAnchor(const AnchorName: string): TAnchorItem; overload;`
	`function BasePath: string; override;`

Properties

	`property OutputFileName: string read FOutputFileName write SetOutputFileName;`
	`property ShortTitle: string read FShortTitle write FShortTitle;`
	`property SourceFileName: string read FSourceFilename write FSourceFilename;`
	`property Title: string read FTitle write FTitle;`
	`property Anchors: TBaseItems read FAnchors;`

Description

Methods

	`procedure HandleTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);`

	`procedure HandleShortTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);`

	`Constructor Create; override;`

	`destructor Destroy; override;`

	`procedure RegisterTags(TagManager: TTagManager); override;`

	`function FindItem(const ItemName: string): TBaseItem; override;`

	`procedure AddAnchor(const AnchorItem: TAnchorItem); overload;`

	`function AddAnchor(const AnchorName: string): TAnchorItem; overload;`
If item with Name (case ignored) already exists, this raises exception EAnchorAlreadyExists. Otherwise it adds TAnchorItem with given name to Anchors. It also returns created TAnchorItem.

	`function BasePath: string; override;`

Properties

	`property OutputFileName: string read FOutputFileName write SetOutputFileName;`
name of documentation output file

	`property ShortTitle: string read FShortTitle write FShortTitle;`

	`property SourceFileName: string read FSourceFilename write FSourceFilename;`

	`property Title: string read FTitle write FTitle;`

	`property Anchors: TBaseItems read FAnchors;`
`Anchors` holds a list of TAnchorItems that represent anchors and sections within the `TExternalItem`. The TAnchorItems have no content so, they should not be indexed separately.

Generated by PasDoc 0.16.0.