Page 252	Table of Contents	Index	Page 254
	Chapters
	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 A, B, C, D, E

CHAPTER 24. INPUT EDITING AND COMPLETION FACILITIES

complete-input returns three values: object, success, and string. In addition, the printed
representation of the completed input will be inserted into the input buffer of stream in place of
the user-supplied string by calling replace-input.

partial-completers is a list of characters that delimit portions of a name that can be completed
separately. The default is an empty list.

If the boolean allow-any-input is true, then complete-input will return as soon as the user
issues an activation gesture, even if the input is not any of the possibilities. If the input is not
one of the possibilities, the three values returned by complete-input will be nil, t, and the
string. The default for allow-any-input is false.

If possibility-printer is supplied, it must be a function of three arguments, a possibility, a pre-
sentation type, and a stream; it has dynamic extent. The function displays the possibility on
the stream. The possibility will be a list of two elements, the first being a string and the second
being the object corresponding to the string.

If help-display-possibilities is true (the default), then when the user issues a help gesture (a
gesture that matches one of the gesture names in *help-gestures*), CLIM will display all the
matching possibilities. If it is false, then CLIM will not display the possibilities unless the user
issues a possibility gesture (a gesture that matches one of the gesture names in *possibilities- gestures*).

=> completing-from-suggestions (stream &key partial-completers allow-any-input possibility-printer)
&body body [Macro]
Reads input from the input editing stream stream, completing over a set of possibilities generated
by calls to suggest within body. body may have zero or more declarations as its first forms.

completing-from-suggestions returns three values, object, success, and string

The stream argument is not evaluated, and must be a symbol that is bound to a stream. If
stream is t (the default), *query-io* is used.

partial-completers, allow-any-input, and possibility-printer are as for complete-input.

Implementations will probably use complete-from-generator to implement this.

=> suggest completion object [Function]
Specifies one possibility for completing-from-suggestions. completion is a string, the printed
representation of object. object is the internal representation.

It is permitted for this function to have lexical scope, and be defined only within the body of
completing-from-suggestions.

=> complete-from-generator string function delimiters &key (action :complete) predicate [Function]
Given an input string string and a list of delimiter characters delimiters that act as partial

Page 252	Table of Contents	Index	Page 254
	Chapters
	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 A, B, C, D, E