find-outline-item

Generic Function

Package: common-graphics

Arguments: outline &optional item-value&key (key #'identity) test only-after-index

Finds and returns the first currently visible outline-item on outline whose value is item-value. If no such outline-item is found, then nil is returned.

key and test are used as in find and related functions for finding the matching value. The value of key should be a function (suitable as the first argument to funcall) of one argument that is applied to a candidate value before comparing it with item-value. The comparison is done with the value of test, which should be a function (suitable as the first argument to funcall) that accepts two arguments and returns true if the arguments should be considered identical. test defaults to the value of the on-change-test event property of outline-item.

If only-after-index is true, it should be a non-negative integer indicating the position of some outline-item to make the search begin with the item just following it (and proceeding downward as usual).

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Copyright (c) 1998-2000, Franz Inc. Berkeley, CA., USA. All rights reserved.

Created 2000.10.5.