Sign in Join
FPDoc Onlineexperiment

TFilterItemEvent procedure type

In unit EditBtn

Specifies an event handler used to filter data items in TCustomControlFilterEdit.

Declaration

pascal
TFilterItemEvent = function(ItemData: Pointer; out Done: Boolean)
: Boolean of object

Arguments

ItemData

Pointer to the data for the item examined in the event handler.

Done

Indicates if additional filtering is needed on the title of the item data.

Function result

True if the item matches the filter implemented in the event handler.

Description

TFilterItemEvent is a Boolean object function type that specifies an event handler used to filter data items in TCustomControlFilterEdit. The return value is True if an item matches a filter condition implemented in the event handler. Done can be updated to indicate if the item requires additional filtering on the title string in the data item; when it contains True, no additional filtering is needed.

TFilterItemEvent is the type used for the OnFilterItem event handler in TCustomControlFilterEdit.

See also

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