Сигнатура

popup-context chooser &key displayer interface book help-key x y =>

Пакет

ystok.help

Аргументы
chooser
Объект графического интерфейса: управляющий элемент или расклад (pinboard), для которого запрашивается контекстная помощь.
displayer
Уточнённый элемент интерфейса, для которого запрашивается контекстная помощь. Если не задан, либо будет совпадать с chooser, либо будет выбран текущий элемент в раскладе.
Идентификатор или дескриптор книги помощи.
interface
nil или объект-окно верхнего уровня, через которое пользователь запросил о помощи.
Идентификатор помощи; если не задан, вычисляется вызовом (capi:help-key displayer).
x, y
Координаты левого верхнего угла всплывающего окна подсказки относительно chooser. Если не заданы, определяются автоматически исходя из расположения элемента displayer.
Возвращаемые значения

Нет.

Описание

Функция ищет и показывает текст контекстной подсказки для элемента displayer окна interface. Окно подсказки "всплывает" в месте экрана, определяемом координатами x и y.

Если соответствующий текст не найден в книге, то система помощи действует в соответствии с настройкой Когда контекстная подсказка не предусмотрена.

Если аргумент book не задан, по умолчанию подсказка ищется в книге *default-book*. В качестве аргумента book может передаваться экземпляр как класса book, так book-system. Последняя возможность удобна для отладки функций помощи на этапе разработки.

Фактически, по идентификатору help-key сначала определяется локатор — строка, служащая для внутренней идентификации контекста и имеющая вид, аналогичный локатору статьи. Локатор сопоставляется с бинарными файлами подсказок *default-book* (и других зарегистрированных книг). Если ему подходит несколько бинарных файлов подсказок, выбирается текст согласно первому из удовлетворяющих дескрипторов в файле якорей.

См. также