hs.hotkey.modal

Создание/управление модальными средами горячих клавиш

Использование:

k = hs.hotkey.modal.new('cmd-shift', 'd')
function k:entered() hs.alert'Entered mode' end
function k:exited()  hs.alert'Exited mode'  end
k:bind('', 'escape', function() k:exit() end)
k:bind('', 'J', 'Pressed J',function() print'let the record show that J was pressed' end)```

Обзор API

Конструкторы - вызовы API, которые возвращают объект, обычно тот, который предоставляет методы API

Методы - вызовы API, которые могут быть выполнены только на объекте, возвращаемом конструктором

bind
delete
enter
entered
exit
exited

Документация API

Конструкторы

new

Подпись	`hs.hotkey.modal.new(mods, key, message) -> hs.hotkey.modal object`
Тип	Конструктор
Описание	Создает новое модальное состояние, необязательно с глобальной комбинацией клавиш для её активации
Параметры	mods - Таблица или строка, содержащая (в качестве элементов или подстрок с любым разделителем) необходимые модификаторы клавиатуры, которые должны быть нулем или более из следующих: "cmd", "command" или "⌘" "ctrl", "control" или "⌃" "alt", "option" или "⌥" "shift" или "⇧" key - Строка, содержащая имя клавиши клавиатуры (как в hs.keycodes.map ), или числового кода клавиши message - Строка, содержащая сообщение, которое будет отображено через `hs.alert()` при срабатывании горячей клавиши, или nil для отсутствия сообщения
Возвращает	Новый объект `hs.hotkey.modal`
Примечания	Если `key` имеет значение nil, глобальная горячая клавиша не будет зарегистрирована (все другие параметры будут проигнорированы)
Исходный код	extensions/hotkey/hotkey.lua строка 552

Методы

bind

Подпись	`hs.hotkey.modal:bind(mods, key, message, pressedfn, releasedfn, repeatfn) -> hs.hotkey.modal object`
Тип	Метод
Описание	Создает горячую клавишу, которая активируется/деактивируется при входе/выходе из модального состояния
Параметры	mods - Таблица или строка, содержащая (в качестве элементов или подстрок с любым разделителем) необходимые модификаторы клавиатуры, которые должны быть нулем или более из следующих: "cmd", "command" или "⌘" "ctrl", "control" или "⌃" "alt", "option" или "⌥" "shift" или "⇧" key - Строка, содержащая имя клавиши клавиатуры (как в hs.keycodes.map ), или числового кода клавиши message - Строка, содержащая сообщение, которое будет отображено через `hs.alert()` при срабатывании горячей клавиши, или nil для отсутствия сообщения pressedfn - Функция, которая будет вызвана при нажатии горячей клавиши, или nil releasedfn - Функция, которая будет вызвана при отпускании горячей клавиши, или nil repeatfn - Функция, которая будет вызвана при повторении нажатой горячей клавиши, или nil
Возвращает	Объект `hs.hotkey.modal` для цепочки методов
Исходный код	extensions/hotkey/hotkey.lua строка 482

delete

Подпись	`hs.hotkey.modal:delete()`
Тип	Метод
Описание	Удаляет объект модальной горячей клавиши без вызова :exited()
Параметры	Нет
Возвращает	Нет
Исходный код	extensions/hotkey/hotkey.lua строка 580

enter

Подпись	`hs.hotkey.modal:enter() -> hs.hotkey.modal object`
Тип	Метод
Описание	Входит в модальное состояние
Параметры	Нет
Возвращает	Объект `hs.hotkey.modal` для цепочки методов
Примечания	Этот метод активирует все горячие клавиши, определённые в модальном состоянии через `hs.hotkey.modal:bind()`, и деактивирует горячую клавишу, которая вызвала вход в модальное состояние (если она была определена) Если модальное состояние было создано с комбинацией клавиш, этот метод будет вызван автоматически
Исходный код	extensions/hotkey/hotkey.lua строка 506

entered

Подпись	`hs.hotkey.modal:entered()`
Тип	Метод
Описание	Необязательный обработчик для входа в модальное состояние
Параметры	Нет
Возвращает	Нет
Примечания	Это существующая функция, которую вы должны переопределить, если вам нужно её использовать; по умолчанию она ничего не делает.
Исходный код	extensions/hotkey/hotkey.lua строка 452

exit

Подпись	`hs.hotkey.modal:exit() -> hs.hotkey.modal object`
Тип	Метод
Описание	Выходит из модального состояния
Параметры	Нет
Возвращает	Объект `hs.hotkey.modal` для цепочки методов
Примечания	Этот метод деактивирует все горячие клавиши, определённые в модальном состоянии, и активирует горячую клавишу входа в модальное состояние (если она была определена)
Исходный код	extensions/hotkey/hotkey.lua строка 530

exited

Подпись	`hs.hotkey.modal:exited()`
Тип	Метод
Описание	Необязательный обработчик для выхода из модального состояния
Параметры	Нет
Возвращает	Нет
Примечания	Это существующая функция, которую вы должны переопределить, если вам нужно её использовать; по умолчанию она ничего не делает.
Исходный код	extensions/hotkey/hotkey.lua строка 467

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.hotkey.modal.html