Sign in Join
FPDoc Onlineexperiment

TLVCompareEvent procedure type

In unit ComCtrls

Specifies an event handler signalled to compare two items in a List View control.

Declaration

pascal
TLVCompareEvent = procedure(Sender: TObject; Item1: TListItem; 
 Item2: TListItem; Data: Integer; 
 var Compare: Integer) of object

Arguments

Sender

Object generating the event notification. It must be cast to the TCustomListView type to access properties or methods specific to the list view control.

Item1

First list item for the comparison.

Item2

Second list item for the comparison.

Data

Contains an Integer value indicating where the items or their data is used in the comparison. The value is normally 0 when signalled, indicating that the list items are used.

Compare

Indicates the relative order for the list items. Negative values indicate Item1 occurs first in the sort order. Positive values indicates Item2 occurs first in the sort order. Zero (0) indicates the list items have the same value.

Description

TLVCompareEvent is the type used to implement the OnCompare event handler in TCustomListView, and implements the Sort method for the control.

See also

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