list-panel-filter-state

list-panel-filter-state Accessor Generic Function

Summary

Accesses the state of the filter in a filtered list-panel.

Package

capi

Signature

list-panel-filter-state list-panel => filter-state

(setf list-panel-filter-state) filter-state list-panel => filter-state

Arguments

`list-panel`⇩	A list-panel.
`filter-state`⇩	A "state" of a filtering-layout or `nil`.

Values

filter-state⇩

A "state" of a filtering-layout or nil.

Description

The accessor generic function list-panel-filter-state accesses the state of the filter in a filtered list-panel (that is, a list-panel created with filter t).

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

(setf list-panel-filter-state) sets the filter in list-panel, filters the unfiltered items and displays those that match the new-state. The new-state has the same semantics as the new-value of (setf filtering-layout-state). It can be a result of a call to list-panel-filter-state or to filtering-layout-state (on a filtering-layout), or a string (meaning plain match, case-insensitive), or nil (meaning match everything).

On an unfiltered list-panel list-panel-filter-state returns nil, and (setf list-panel-filter-state) does nothing.