list-panel-items-and-filter

list-panel-items-and-filter Accessor

Summary

Accesses the unfiltered items and filter in a list-panel.

Package

capi

Signature

list-panel-items-and-filter list-panel => unfiltered-items, filter-state

setf (list-panel-items-and-filter list-panel) (values unfiltered-items filter-state) => unfiltered-items, filter-state

Arguments

`list-panel`⇩	A list-panel.
`unfiltered-items`	A sequence.
`filter-state`⇩	A "state" for a filtering-layout.

Values

`unfiltered-items`	A sequence.
`filter-state`⇩	A "state" for a filtering-layout.

Description

The accessor list-panel-items-and-filter accesses the unfiltered items and the state of the filter in the list panel list-panel simultaneously. It is especially useful for setting the filter state and the items without flickering.

list-panel-items-and-filter returns the items and filter state in list-panel as multiple values. It is equivalent to:

(values (list-panel-unfiltered-items list-panel)
        (list-panel-filter-state list-panel))

but is more efficient.

The return value filter-state is the same type as the state that is used in filtering-layout.

The setf form of list-panel-items-and-filter takes the items and new filter state as two values and sets them in list-panel:

These two forms:

(setf (list-panel-items-and-filter list-panel)
      (values new-items new-filter-state))

(progn
  (setf (list-panel-unfiltered-items list-panel) new-items)
  (setf (list-panel-filter-state list-panel) new-filter-state))

have the same ultimate effect on list-panel, but the latter form will filter new-items with the old filter and display the result and then filter new-items again with new-filter-state, whereas the setf form of list-panel-items-and-filter filters new-items just once, with new-filter-state.