select-on-multiple-characters-callback

Arguments: outline

Returns the value of the select-on-multiple-characters-callback property of an outline control. The value may be specified at creation time by passing the select-on-multiple-characters-callback initarg to make-instance, or any time later by calling (setf select-on-multiple-characters-callback).

This outline widget property has an effect only when the outline's select-on-multiple-characters property is true to allow finding an outline item by typing the first several characters of the string that it displays.

In that case, this property should be the name of a function that will be called whenever the search string has changed, or else nil to not call a function. The default value is nil. The callback function would typically be used to display the current search string somewhere near the outline. The function will be called each time the user types or erases a character, and also when the select-on-multiple-characters-time-limit expires.

The function should accept two arguments, which will be the outline control and the current search string. The search string argument will be a string when the user has typed or erased a character, or nil when the time limit has expired.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page is new in the 9.0 release.
Created 2019.8.20.