TListItems class

In unit ComCtrls

Implements a container for list items on a list view control.

Declaration

pascal

TListItems = class(TPersistent)

Inheritance

TListItems
TPersistent
TObject

Descends from it: TOwnerDataListItems

Description

TListItems is a TPersistent descendant which implements the container used to store TListItem instances used in a TCustomListView control. The Owner of the container is the TCustomListView control passed as an argument to the constructor.

TListItems is the type used to implement the Items property in TCustomListView.

TListItems provides properties and methods needed to maintain and access the TListItem instances stored in the list for the container. Item is the default property for the class instance and allows access to the list items by their ordinal position in the container. It also the target for an enumerator using the TListItemsEnumerator supported in the class instance.

TListitems has a built-in cache for the last accessed item. This will speed up interface updates since Item.Index is often used for the same item updating more properties. If FCacheIndex contains -1 then the cache is not valid.

Properties

`Flags`	public	Contains the flag values currently assigned to the list.
`Count`	public	The number of TListItem instances stored in the container.
`Item`	public	Provides indexed access to the TListItem instance in the container by their ordinal position.
`Owner`	public	List view control that is the owner of the container and its list items.

Methods

`DefineProperties`	protected	Defines read and write routines used for binary Data in the list items for the container.
`GetCount`	protected	Gets the value for the Count property.
`GetItem`	protected	Gets the value for the indexed Item property.
`GetOwner`	protected	Gets the value for the Owner property.
`WSCreateItems`	protected	Creates list items in the widgetset class, and cache entries for the values.
`DoFinalizeWnd`	protected	Updates flags in the class instance when the widgetset handle is freed.
`SetCount`	protected	Sets the value for the Count property.
`SetItem`	protected	Set the value in the indexed Item property.
`ClearSelection`	protected	Clears the selected state for all TListItem instances in the container.
`SelectAll`	protected	Sets the selected state to True for all TListItem instances in the container.
`Add`	public	Adds a new list item to the container.
`AddItem`	public	Adds the specified list item to the storage for the container.
`BeginUpdate`	public	Starts an update process for the container and its list view control.
`Clear`	public	Removes all list item instances stored in the container.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Delete`	public	Removes the list item specified in AIndex from the container.
`EndUpdate`	public	Ends an update process for the container and its list view control.
`Exchange`	public	Exchanges the positions for the specified list items in the container.
`Move`	public	Moves the list item at the specified position to a new position in the container.
`FindCaption`	public	Locates a list item with the specified caption starting at given position in the container.
`FindData`	public	Locates the list item which has the specified values in its Data property.
`GetEnumerator`	public	Gets an enumerator for the list items in the container.
`IndexOf`	public	Gets the ordinal position in the container for the specified list item.
`Insert`	public	Creates and inserts a list item at the specified ordinal position in the container.
`InsertItem`	public	Inserts the specified list item at the specified position in the internal storage for the container.

Inherited

From TPersistent (6)

Assign AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers GetNamePath

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.