Class TPasItems

Unit

Declaration

type TPasItems = class(TBaseItems)

Description

Container class to store a list of TPasItems.

Source: source/component/PasDoc_Items.pas (line 1157).

Hierarchy

Overview

Methods

Public function FindListItem(const ASignature: string): TPasItem;
Public procedure CopyItems(const c: TPasItems);
Public procedure CountCIO(var c, i, o: Integer);
Public procedure RemovePrivateItems;
Public procedure SortDeep(const SortSettings: TSortSettings);
Public procedure SortOnlyInsideItems(const SortSettings: TSortSettings);
Public procedure SortShallow;
Public procedure SetFullDeclaration(PrefixName: boolean; const Suffix: string);

Properties

Public property PasItemAt[const AIndex: Integer]: TPasItem read GetPasItemAt write SetPasItemAt;

Description

Methods

Public function FindListItem(const ASignature: string): TPasItem;

A comfortable routine that just calls inherited and casts result to TPasItem, since every item on this list must be always TPasItem.

Source: source/component/PasDoc_Items.pas (line 1165).

Public procedure CopyItems(const c: TPasItems);

Copies all Items from c to this object, not changing c at all.

Source: source/component/PasDoc_Items.pas (line 1168).

Public procedure CountCIO(var c, i, o: Integer);

Counts classes, interfaces and objects within this collection.

Source: source/component/PasDoc_Items.pas (line 1171).

Public procedure RemovePrivateItems;

Checks each element's Visibility field and removes all elements with a value of viPrivate.

Source: source/component/PasDoc_Items.pas (line 1175).

Public procedure SortDeep(const SortSettings: TSortSettings);

This sorts all items on this list by their name, and also calls Sort(SortSettings) for each of these items. This way it sorts recursively everything in this list.

This is equivalent to doing both SortShallow and SortOnlyInsideItems.

Source: source/component/PasDoc_Items.pas (line 1187).

Public procedure SortOnlyInsideItems(const SortSettings: TSortSettings);

This calls Sort(SortSettings) for each of items on the list. It does not sort the items on this list.

Source: source/component/PasDoc_Items.pas (line 1192).

Public procedure SortShallow;

This sorts all items on this list by their name. Unlike SortDeep, it does not call Sort for each of these items. So "items inside items" (e.g. class methods, if this list contains TPasCio objects) remain unsorted.

Source: source/component/PasDoc_Items.pas (line 1199).

Public procedure SetFullDeclaration(PrefixName: boolean; const Suffix: string);

Sets FullDeclaration of every item to

  1. Name of this item (only if PrefixName)

  2. + Suffix.

Very useful if you have a couple of items that share a common declaration in source file, e.g. variables or fields declared like

A, B: Integer;

Source: source/component/PasDoc_Items.pas (line 1211).

Properties

Public property PasItemAt[const AIndex: Integer]: TPasItem read GetPasItemAt write SetPasItemAt;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 1177).


Generated by PasDoc 0.17.0.snapshot.