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

NextPrevUpTopContentsIndex

list-panel-items-and-filter

Function
Summary

Accesses the unfiltered items and filter in a list-panel

Signature

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

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

Description

The function 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.

(setf 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 the new-items with the old filter and display the result and then filter the new-items again with the new-filter-state , whereas (setf list-panel-items-and-filter) filters the new-items just once, with the new-filter-state .

See also

list-panel
list-panel-filter-state
list-panel-unfiltered-items


CAPI User Guide and Reference Manual (Unix version) - 3 Aug 2017

NextPrevUpTopContentsIndex