list-widget-set-index

Arguments: list-widget index &optional off-p &key trigger-on-change

Changes the selection status of list-widget's item at the given index. If off-p is true the item will be deselected; otherwise it will be selected.

If trigger-on-change is true, then the value is changed by calling (setf value), which will call the widget's on-change function for a new value. If nil, then the value slot is set directly and the on-change function will never run. The default is nil for backward compatibility, though it is typically best to pass this argument as true.

The return value is undefined. (In releases prior to 8.1, when there was no trigger-on-change argument, this function returned true if the change was effective and nil if there was an error. The return value can no longer be interpreted to indicate success or failure.)

If list-widget is a multi-item-list and the index that is passed is -1, then all of the items are deselected if off-p is true and are selected if off-p is nil. off-p defaults to nil.

list-widget can be a single-item-list, a multi-item-list, or a combo-box.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.