All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

remove-items Generic Function

Summary

Removes some items from a collection.

Package

capi

Signature

remove-items collection list-or-predicate

Arguments
collection
A collection.
list-or-predicate
A list, or a function of one argument returning a boolean value.
Description

The generic function remove-items removes from the collection collection those items determined by list-or-predicate.

If list-or-predicate is list, then the items removed are those matching some element of list-or-predicate, compared by the test-function of collection. Otherwise, the items removed are those for which the function list-or-predicate returns true.

This is logically equivalent to recalculating the collection items and then calling (setf collection-items). However, remove-items is more efficient and causes less flickering on screen.

remove-items can only be used when the collection has the default items-get-function svref.

Notes

remove-items cannot be used a graph-pane or a tree-view.

See also

append-items
collection
replace-items
5 Choices - panes with items


CAPI User Guide and Reference Manual (Windows version) - 01 Dec 2021 19:33:57