Brook Tardigrade

Class TBrookURLEntryPointList

Description
Hierarchy
Fields
Methods
Properties

Unit

BrookURLEntryPoints

Declaration

type TBrookURLEntryPointList = class(TBrookHandledOwnedCollection)

Description

Class to represent an list of URL entry-points.

Hierarchy

Overview

Methods

Public constructor Create(AOwner: TPersistent); virtual;
Public destructor Destroy; override;
Public class function GetEntryPointClass: TBrookURLEntryPointClass; virtual;
Public function GetEnumerator: TBrookURLEntryPointListEnumerator;
Public procedure Prepare; virtual;
Public procedure Unprepare; virtual;
Public function IsPrepared: Boolean; virtual;
Public function NewName: string; virtual;
Public function Add: TBrookURLEntryPoint; virtual;
Public function Remove(const AName: string): Boolean; virtual;
Public function IndexOf(const AName: string): Integer; virtual;
Public function FindInList(const AName: string): TBrookURLEntryPoint; virtual;
Public function Find(const APath: string; out AUserData): Boolean; virtual;
Public procedure Clear; virtual;

Properties

Public property Items[AIndex:Integer]: TBrookURLEntryPoint read GetItem write SetItem;
Public property Prepared: Boolean read IsPrepared;

Description

Methods

Public constructor Create(AOwner: TPersistent); virtual;

Creates an instance of TBrookURLEntryPointList.

Parameters
AOwner[in]
Entry-points persistent.
Public destructor Destroy; override;

Frees an instance of TBrookURLEntryPointList.

Public class function GetEntryPointClass: TBrookURLEntryPointClass; virtual;

Gets the default class for entry-point item creation.

Public function GetEnumerator: TBrookURLEntryPointListEnumerator;

Creates an enumerator to iterate the entry-points though for..in.

Public procedure Prepare; virtual;

Prepares entry-points handle.

Public procedure Unprepare; virtual;

Unprepares entry-points handle.

Public function IsPrepared: Boolean; virtual;

Checks if entry-points handle is prepared.

Public function NewName: string; virtual;

Creates a new entry-point name.

Public function Add: TBrookURLEntryPoint; virtual;

Adds a new item to the entry-point list.

Returns

Entry-point item.

Public function Remove(const AName: string): Boolean; virtual;

Removes an item from the entry-point list by its name.

Parameters
AName[in]
Entry-point name.
Returns

True if an entry-point is removed.

Public function IndexOf(const AName: string): Integer; virtual;

Gets the entry-point index by its name.

Public function FindInList(const AName: string): TBrookURLEntryPoint; virtual;

Finds an entry-point in the entry-point list by its name.

Parameters
AName[in]
Entry-point name.
Returns

Entry-point item.

Public function Find(const APath: string; out AUserData): Boolean; virtual;

Finds an user-data in the entry-point list by entry-point path.

Parameters
APath[in]
Entry-point path.
AUserData[out]
User-defined data.
Returns

True if user-data is found.

Public procedure Clear; virtual;

Clears the entry-point list.

Properties

Public property Items[AIndex:Integer]: TBrookURLEntryPoint read GetItem write SetItem;

Gets/sets an entry-point from/to the entry-point list by its index.

Public property Prepared: Boolean read IsPrepared;

True if entry-points handle is prepared.

Generated by PasDoc 0.16.0.