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

modify-multi-column-list-panel-columns Function

Summary

Modify the columns of a multi-column-list-panel.

Package

capi

Signature

modify-multi-column-list-panel-columns self &key columns x-adjust reorderable-columns sort-descriptions column-function item-print-functions

Arguments
self
columns
A list of column specifications.
x-adjust
A list.
reorderable-columns
A list.
sort-descriptions
A list.
column-function
A function of one argument or a list of functions of one argument. The default is identity.
item-print-functions
A function of one argument, or a list of such functions.
Description

The function modify-multi-column-list-panel-columns modifies the columns of self.

All the keyword arguments have the same meaning as the corresponding initargs in multi-column-list-panel. See the entry for multi-column-list-panel for details.

For all the keyword arguments except x-adjust and reorderable-columns, if they are not supplied then the value does not change. For all keyword arguments except sort-descriptions, x-adjust and reorderable-columns, if they are passed as nil then the corresponding value does not change. If sort-descriptions is passed as nil, then the sort-descriptions are changed to nil.

Notes
  1. columns and column-function need to match, so normally you modify them both. Supplying column-function as a list of functions makes it easier to match, by just making column-function a list parallel to columns.
  2. An alternative solution is to use a column-function that decides dynamically what values to return based on some value that you set when you call modify-multi-column-list-panel-columns. For example you can make column-function a function that closes over the containing interface, and check a slot in it to decide which columns to return, and then update this slot whenever you call modify-multi-column-list-panel-columns.
  3. If item-print-functions is a list, it will also have to be updated when columns are updated.
  4. If columns is supplied then x-adjust and reorderable-columns are also used to modify the columns, so you might need to supply them as well. x-adjust and reorderable-columns are ignored if columns is not supplied.
  5. Since sort-descriptions are searched, they do not need to be updated when columns is updated, provided that they already contain all the sort kinds that any column may use.
See also

multi-column-list-panel


CAPI User Guide and Reference Manual (Unix version) - 01 Dec 2021 19:32:42