hs.chooser

Глобальная функция обратного вызова, используемая для различных событий hs.chooser

• Эта функция обратного вызова должна принимать два параметра:
• Объект hs.chooser
• Строка, содержащая имя события для обработки. Возможные значения:
• willOpen - hs.chooser собирается отобразиться на экране
• didClose - hs.chooser только что был удалён с экрана
• Существует стандартная функция обратного вызова, которая использует событие willOpen, чтобы запомнить, какое окно имеет фокус, и событие didClose, чтобы восстановить фокус в исходном окне. Если вы хотите использовать это дополнительно к своему обработающему событию, вы можете вызвать его так: hs.chooser._defaultGlobalCallback(event)

Создаёт новый объект chooser

• completionFn - Функция, которая будет вызвана, когда окно chooser будет закрыто. Она должна принимать один параметр, который будет nil, если пользователь закрыл окно chooser, иначе это будет таблица, содержащая информацию, которую вы предоставили для выбранного элемента.

• Объект hs.chooser

• Начиная с macOS Sierra и более поздних версий, если вы хотите, чтобы объект hs.chooser отображался поверх полноэкранных окон, вы должны сначала скрыть значок Hammerspoon Dock, используя: hs.dockicon.hide()

Получение или прикрепление/открепление панели инструментов к/от выбора.

• toolbar - Объект hs.webview.toolbar, который нужно прикрепить к выбору. Если nil указан, текущая панель инструментов будет удалена

• если указан объект toolbarObject или явное nil, возвращается объект hs.chooser; в противном случае возвращается текущий объект toolbarObject или nil, если к выбору ничего не прикреплено.

• Этот метод — это удобная обертка для функции hs.webview.toolbar.attachToolbar.

• Если объект toolbarObject в данный момент прикреплен к другому окну при вызове этого метода, он будет откреплен от исходного окна и прикреплен к выбору. Если вы хотите прикрепить одну и ту же панель инструментов к нескольким объектам выбора, см. hs.webview.toolbar:copy.

Устанавливает фон выбора между светлым и тёмным.

• beDark - Необязательный булевый параметр, true — для тёмного фона, false — для светлого. Если этот параметр опущен, будет возвращено текущее значение.

• Объект hs.chooser или булево значение: true, если окно тёмное, false — если светлое.

• Цвета текста не будут автоматически изменены при переключении тёмного режима окна выбора. Вы также должны установить соответствующие цвета с помощью hs.chooser:fgColor() и hs.chooser:subTextColor()

Отменяет выбор.

• Нет

• Объект hs.chooser

Устанавливает варианты выбора.

• choices - Либо функция, вызываемая при необходимости списка вариантов, либо nil для удаления существующих вариантов/обратного вызова, либо таблица со статическими вариантами.

• Объект hs.chooser

• Таблица вариантов (статистически заданная или возвращаемая обратным вызовом) должна содержать как минимум следующие ключи для каждого варианта:
• text - Строка или объект hs.styledtext, который будет отображен как основной текст варианта
• Каждый вариант также может необязательно содержать следующие ключи:
• subText - Строка или объект hs.styledtext, который будет отображен под основным текстом варианта
• image - Объект изображения hs.image , который будет отображен рядом с вариантом
• valid - Булево значение, по умолчанию true, если установлено значение false, выбор варианта вызовет метод invalidCallback вместо закрытия выбора
• Любые другие ключи/значения в каждой таблице вариантов сохранятся выбором и будут возвращены обратно в обратный вызов при выборе. Это полезно для хранения UUID или другой информации, не связанной с пользователем, однако важно отметить, что вы не должны хранить объекты userdata в таблице — они проходят через внутренние функции преобразования, поэтому должны храниться только базовые типы Lua.
• Если указана функция, она будет вызвана один раз, когда окно выбора отображается. Результаты кэшируются, пока не будет вызван этот метод снова или не будет вызван hs.chooser:refreshChoicesCallback().
• Если вы используете объект hs.styledtext для выбора текста или subText, убедитесь, что вы задали цвет, в противном случае текст может отображаться как прозрачный в зависимости от настройки bgDark.

Пример:

local choices = {
{
 ["text"] = "First Choice",
 ["subText"] = "This is the subtext of the first choice",
 ["uuid"] = "0001"
},
{ ["text"] = "Second Option",
  ["subText"] = "I wonder what I should type here?",
  ["uuid"] = "Bbbb"
},
{ ["text"] = hs.styledtext.new("Third Possibility", {font={size=18}, color=hs.drawing.color.definedCollections.hammerspoon.green}),
  ["subText"] = "What a lot of choosing there is going on here!",
  ["uuid"] = "III3"
},
}```

Удаляет выбор.

• Нет

• Нет

Получение/установка того, должен ли выбор вызывать обратный вызов при запросе, не совпадающем с никаким в списке.

• enableDefaultForQuery - Необязательный булевый параметр, true — возвращает строку запроса, false — не возвращает. Если этот параметр опущен, будет возвращено текущее значение конфигурации.

• объект hs.chooser если значение было установлено, или булево значение, если параметр не передавался.

• Это нужно использовать до отображения выбора.

Устанавливает цвет переднего плана выбора

• цвет - необязательная таблица, содержащая описание цвета (см. hs.drawing.color), или nil для восстановления значения по умолчанию. Если этот параметр опущен, будет возвращен текущий цвет

• Объект hs.chooser или таблица цветов

Скрывает выбор

• Нет

• Объект hs.chooser

Устанавливает/очищает обратный вызов при скрытии окна выбора

• fn - необязательная функция, которая будет вызвана при скрытии окна выбора. Если этот параметр опущен, существующий обратный вызов будет удален.

• Объект hs.chooser

• Этот обратный вызов вызывается после скрытия выбора.
• Этот обратный вызов вызывается после hs.chooser.globalCallback.

Устанавливает/очищает обратный вызов для невалидных выборов

• fn - необязательная функция, которая будет вызвана всякий раз, когда пользователь выбирает элемент, помеченный как невалидный. Если этот параметр опущен, существующий обратный вызов будет удален.

• Объект hs.chooser

• Обратный вызов может принимать один аргумент, это будет таблица, содержащая информацию, которую вы предоставили для выбранного пользователем элемента.
• Для отображения контекстного меню, см. hs.menubar, в частности метод :popupMenu()

Проверяет, отображается ли выбор в данный момент

• Нет

• Булево значение, true, если выбор отображается на экране, false — если нет

Устанавливает/получает текст метки, отображаемый в поле ввода запроса, когда нет другого текста

• placeholderText - необязательная строка для текста метки. Если этот параметр опущен, будет возвращен существующий текст метки.

• Объект hs.chooser или существующий текст метки

Устанавливает/получает строку поиска

• queryString - необязательная строка для поиска или явное nil для очистки запроса. Если опущено, возвращаются текущие содержимое поля поиска.

• Объект hs.chooser или строка

• Вы можете явно указать nil или пустую строку для очистки текущей строки запроса.

Устанавливает/очищает обратный вызов при изменении строки поиска

• fn - необязательная функция, которая будет вызываться всякий раз, когда меняется строка поиска. Если этот параметр опущен, существующий обратный вызов будет удален.

• Объект hs.chooser

• По мере ввода пользователем текста функция обратного вызова будет вызываться при каждом нажатии клавиши. Вы можете выполнить фильтрацию при каждом вызове или использовать объект hs.timer с задержкой, чтобы реагировать только после завершения ввода.
• Функция обратного вызова должна принимать один аргумент:
• Строка, содержащая новую строку поиска

Обновляет данные выбора из обратного вызова

• reload - необязательный параметр, перезагружающий результаты выбора, учитывая текущую строку запроса (по умолчанию false)

• Объект hs.chooser

• Этот метод не будет выполняться, если вы не задали функцию с помощью hs.chooser:choices()

Устанавливает/очищает обратный вызов при нажатии правой кнопки мыши на выборе

• fn - необязательная функция, которая будет вызываться всякий раз, когда пользователь щелкает правой кнопкой мыши на выборе. Если этот параметр опущен, существующий обратный вызов будет удален.

• Объект hs.chooser

• Обратный вызов может принимать один аргумент, номер строки, где произошел щелчок правой кнопкой мыши, или 0, если в данный момент нет строки, на которой произошел щелчок. Для определения местоположения указателя мыши при щелчке правой кнопкой см. hs.mouse.
• Для отображения контекстного меню, см. hs.menubar, в частности, метод :popupMenu()

Получение/установка количества отображаемых строк

• numRows - необязательное число отображаемых элементов (т.е. вертикальная высота окна выбора). Если этот параметр опущен, возвращается текущее значение.

• Объект hs.chooser или число

Устанавливает/получает, должен ли выбор искать в подстроках каждого элемента

• searchSubText - необязательный булевый параметр, true для поиска в подстроках, false — для отказа от поиска в подстроках. Если этот параметр опущен, возвращается текущее значение конфигурации.

• Объект hs.chooser если значение было установлено, или булево значение, если параметр не был передан.

• Это следует использовать до отображения выбора.

Закрывает выборщик, выбрав указанную строку или текущую выбранную строку, если она не указана.

• row - необязательное целое число, определяющее строку для выбора.

• Объект hs.chooser

Получение или установка текущей выбранной строки

• row - необязательное целое число, определяющее строку для выбора.

• Если аргумент предоставлен, возвращает объект hs.chooser; в противном случае возвращает число, содержащее текущую выбранную строку (т.е. ту, которая выделена в пользовательском интерфейсе)

Возвращает содержимое текущей или указанной строки

• row - необязательное целое число, определяющее конкретную строку, содержимое которой нужно вернуть

• таблицу, содержащую любую информацию, предоставленную для текущей выбранной строки, или пустую таблицу, если ни одна строка не выбрана или указанная строка не существует.

Отображает выборщик

• Необязательный объект точки hs.geometry, описывающий абсолютные координаты экрана для левой верхней точки окна выборщика. По умолчанию окно центрируется на основном экране.

• Объект hs.chooser

Устанавливает/очищает обратный вызов для показа окна выборщика

• fn - Необязательная функция, которая будет вызвана при отображении окна выборщика. Если этот параметр опущен, существующий обратный вызов будет удален.

• Объект hs.chooser

• Этот обратный вызов вызывается после отображения выборщика. Чтобы выполнить код непосредственно перед его отображением (и/или после его удаления), см. hs.chooser.globalCallback.

Устанавливает цвет подстрочного текста выборщика

• color - Необязательная таблица, содержащая описание цвета (см. hs.drawing.color), или nil для восстановления значения по умолчанию. Если этот параметр опущен, будет возвращён существующий цвет.

• Объект hs.chooser или таблицу цветов

Получение/Установка ширины выборщика

• percent - Необязательное число, указывающее процент ширины экрана, который должен занимать выборщик. Если этот параметр опущен, будет возвращена текущая ширина.

• Объект hs.chooser или число

• Это следует использовать до отображения выборщика