Spec-Zone.ru › Hammerspoon

hs.hotkey

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

Подмодули

  • hs.hotkey.modal

Обзор API

  • Переменные - Настраиваемые значения
    • alertDuration
  • Функции - API-вызовы, предоставляемые напрямую расширением
    • assignable
    • deleteAll
    • disableAll
    • getHotkeys
    • showHotkeys
    • systemAssigned
  • Конструкторы - API-вызовы, возвращающие объект, обычно с методами API
    • bind
    • bindSpec
    • new
  • Методы - API-вызовы, которые могут быть выполнены только на объекте, возвращённом конструктором
    • delete
    • disable
    • enable

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

Переменные

alertDuration
Подпись hs.hotkey.alertDuration
Тип Переменная
Описание

Продолжительность всплывающего сообщения, отображаемого при срабатывании сочетания клавиш, созданного с параметром message, в секундах. По умолчанию 1.

Источник extensions/hotkey/hotkey.lua строка 31

Функции

assignable
Подпись hs.hotkey.assignable(mods, key) -> boolean
Тип Функция
Описание

Определяет, можно ли назначить сочетанию клавиш обратный вызов через Hammerspoon.

Параметры
  • mods - Таблица или строка, содержащая (как элементы или подстроки с любым разделителем) необходимые модификаторы клавиатуры, которые могут быть одним или несколькими из следующих:
    • "cmd", "command" или "⌘"
    • "ctrl", "control" или "⌃"
    • "alt", "option" или "⌥"
    • "shift" или "⇧"
  • key - Строка, содержащая имя клавиши (как в hs.keycodes.map), или числовое значение кода клавиши
Возвращаемое значение
  • булево значение, true, если сочетание клавиш может быть назначено Hammerspoon, или false, если нет.
Примечания
  • Наиболее распространённая причина, по которой сочетание клавиш не может быть назначено Hammerspoon, заключается в том, что оно используется операционной системой macOS — см. вкладку «Сочетания клавиш» в «Клавиатуре» в настройках системы или hs.hotkey.systemAssigned.
Источник extensions/hotkey/hotkey.lua строка 254
deleteAll
Подпись hs.hotkey.deleteAll(mods, key)
Тип Функция
Описание

Удаляет все ранее установленные обратные вызовы для заданного сочетания клавиш

Параметры
  • mods - Таблица или строка, содержащая (как элементы или подстроки с любым разделителем) необходимые модификаторы клавиатуры, которые могут быть одним или несколькими из следующих:
    • "cmd", "command" или "⌘"
    • "ctrl", "control" или "⌃"
    • "alt", "option" или "⌥"
    • "shift" или "⇧"
  • key - Строка, содержащая имя клавиши (как в hs.keycodes.map), или числовое значение кода клавиши
Возвращаемое значение
  • Ничего
Источник extensions/hotkey/hotkey.lua строка 304
disableAll
Подпись hs.hotkey.disableAll(mods, key)
Тип Функция
Описание

Отключает все ранее установленные обратные вызовы для заданного сочетания клавиш

Параметры
  • mods - Таблица или строка, содержащая (как элементы или подстроки с любым разделителем) необходимые модификаторы клавиатуры, которые могут быть одним или несколькими из следующих:
    • "cmd", "command" или "⌘"
    • "ctrl", "control" или "⌃"
    • "alt", "option" или "⌥"
    • "shift" или "⇧"
  • key - Строка, содержащая имя клавиши (как в hs.keycodes.map), или числовое значение кода клавиши
Возвращаемое значение
  • Ничего
Источник extensions/hotkey/hotkey.lua строка 284
getHotkeys
Подпись hs.hotkey.getHotkeys() -> table
Тип Функция
Описание

Возвращает список всех активных сочетаний клавиш

Параметры
  • Нет
Возвращаемое значение
  • Таблица, содержащая активные сочетания клавиш (т.е. включённые и не "затенённые" в текущем контексте) — обычно это глобальный контекст сочетаний клавиш, но это может быть контекст модального сочетания клавиш. Каждый элемент в списке — таблица с двумя полями:
    • idx - строка, описывающая сочетание клавиш для сочетания
    • msg - сообщение сочетания клавиш, если оно было указано при создании сочетания (префикс с сочетанием клавиш)
Источник extensions/hotkey/hotkey.lua строка 326
showHotkeys
Подпись hs.hotkey.showHotkeys(mods, key) -> hs.hotkey object
Тип Функция
Описание

Создаёт (и включает) сочетание клавиш, которое отображает все текущие активные сочетания клавиш (т.е. включённые и не "затенённые" в текущем контексте) при удерживании

Параметры
  • mods - Таблица или строка, содержащая (как элементы или подстроки с любым разделителем) необходимые модификаторы клавиатуры, которые могут быть одним или несколькими из следующих:
    • "cmd", "command" или "⌘"
    • "ctrl", "control" или "⌃"
    • "alt", "option" или "⌥"
    • "shift" или "⇧"
  • key - Строка, содержащая имя клавиши (как в hs.keycodes.map), или числовое значение кода клавиши
Возвращаемое значение
  • Новый hs.hotkey объект
Источник extensions/hotkey/hotkey.lua строка 340
systemAssigned
Подпись hs.hotkey.systemAssigned(mods, key) -> table | false
Тип Функция
Описание

Проверяет, используется ли потенциальное сочетание клавиш системой macOS, такие как клавиши захвата экрана, универсального доступа и навигации по клавиатуре.

Параметры
  • mods - Таблица или строка, содержащая (как элементы или подстроки с любым разделителем) необходимые модификаторы клавиатуры, которые могут быть одним или несколькими из следующих:
    • "cmd", "command" или "⌘"
    • "ctrl", "control" или "⌃"
    • "alt", "option" или "⌥"
    • "shift" или "⇧"
  • key - Строка, содержащая имя клавиши (как в hs.keycodes.map), или числовое значение кода клавиши
Возвращаемое значение
  • Если сочетание клавиш используется системной функцией, возвращает таблицу со следующими ключами:
    • keycode - числовое значение кода клавиши для сочетания
    • mods - числовое представление флагов модификаторов для сочетания
    • enabled - булево значение, указывающее, включена ли клавиша в данный момент
  • Если сочетание клавиш не используется операционной системой, возвращает булевое значение false.
Примечания
  • Эта функция предоставлена для информационных целей и не является надёжным инструментом проверки возможности использования сочетания Hammerspoon для создания пользовательского сочетания клавиш — некоторые сочетания, возвращающие таблицу, могут переопределяться Hammerspoon, в то время как другие нет. См. также hs.hotkey.assignable.
Источник extensions/hotkey/hotkey.lua строка 225

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

bind
Signature hs.hotkey.bind(mods, key, [message,] pressedfn, releasedfn, repeatfn) -> hs.hotkey object
Type Конструктор
Description

Создаёт новую комбинацию клавиш и сразу же её активирует

Parameters
  • mods - Таблица или строка, содержащая (в качестве элементов или подстрок с любым разделителем) необходимые модификаторы клавиатуры, которые должны быть нулем или более следующих:
    • "cmd", "command" или "⌘"
    • "ctrl", "control" или "⌃"
    • "alt", "option" или "⌥"
    • "shift" или "⇧"
  • key - Строка, содержащая имя клавиши клавиатуры (как указано в hs.keycodes.map), или непосредственное числовое значение кода клавиши
  • message - (необязательно) Строка, содержащая сообщение, отображаемое при срабатывании комбинации клавиш с помощью hs.alert(); если опущено, никакое сообщение не будет показано
  • pressedfn - Функция, которая будет вызвана при нажатии комбинации клавиш, или nil
  • releasedfn - Функция, которая будет вызвана при отпускании комбинации клавиш, или nil
  • repeatfn - Функция, которая будет вызвана при повторении нажатой комбинации клавиш, или nil
Returns
  • Новый объект hs.hotkey или nil, если комбинация клавиш не может быть активирована
Notes
  • Эта функция — всего лишь обёртка, выполняющая hs.hotkey.new(...):enable()
  • Вы можете создать несколько объектов hs.hotkey для одной и той же комбинации клавиш, но только один может быть активным в любой момент — см. hs.hotkey:enable()
  • Если message пустая строка "", всплывающее сообщение просто покажет нажатую комбинацию клавиш
  • Если вы не хотите никакого сообщения, вы должны опустить параметр message; nil в третьем месте будет интерпретировано как отсутствие pressedfn
  • Вы должны передать хотя бы один из pressedfn, releasedfn или repeatfn; для удаления комбинации клавиш используйте hs.hotkey:delete()
Source extensions/hotkey/hotkey.lua строка 385
bindSpec
Signature hs.hotkey.bindSpec(keyspec, ...) -> hs.hotkey object
Type Конструктор
Description

Создаёт комбинацию клавиш и сразу же её активирует

Parameters
  • keyspec - Таблица, содержащая два элемента:
    • first, таблица, содержащая модификаторы клавиатуры, как указано в hs.hotkey.bind()
    • second, строка, содержащая имя клавиши клавиатуры, как указано в hs.hotkey.bind()
  • ... - Все остальные аргументы указаны в hs.hotkey.bind()
Returns
  • Новый объект hs.hotkey для цепочки методов
Notes
  • Эта функция — всего лишь обёртка, выполняющая hs.hotkey.bind(keyspec[1], keyspec[2], ...)
Source extensions/hotkey/hotkey.lua строка 418
new
Signature hs.hotkey.new(mods, key, [message,] pressedfn, releasedfn, repeatfn) -> hs.hotkey object
Type Конструктор
Description

Создаёт новую комбинацию клавиш

Parameters
  • mods - Таблица или строка, содержащая (в качестве элементов или подстрок с любым разделителем) необходимые модификаторы клавиатуры, которые должны быть нулем или более следующих:
    • "cmd", "command" или "⌘"
    • "ctrl", "control" или "⌃"
    • "alt", "option" или "⌥"
    • "shift" или "⇧"
  • key - Строка, содержащая имя клавиши клавиатуры (как указано в hs.keycodes.map), или непосредственное числовое значение кода клавиши
  • message - (необязательно) Строка, содержащая сообщение, отображаемое при срабатывании комбинации клавиш с помощью hs.alert() при нажатии; если опущено, никакое сообщение не будет показано
  • pressedfn - Функция, которая будет вызвана при нажатии комбинации клавиш, или nil
  • releasedfn - Функция, которая будет вызвана при отпускании комбинации клавиш, или nil
  • repeatfn - Функция, которая будет вызвана при повторении нажатой комбинации клавиш, или nil
Returns
  • Новый объект hs.hotkey или nil, если комбинация клавиш не может быть активирована
Notes
  • Вы можете создать несколько объектов hs.hotkey для одной и той же комбинации клавиш, но только один может быть активным в любой момент — см. hs.hotkey:enable()
  • Если message пустая строка "", всплывающее сообщение просто покажет нажатую комбинацию клавиш
  • Если вы не хотите никакого сообщения, вы должны опустить параметр message; nil в третьем месте будет интерпретировано как отсутствие pressedfn
  • Вы должны передать хотя бы один из pressedfn, releasedfn или repeatfn; для удаления комбинации клавиш используйте hs.hotkey:delete()
Source extensions/hotkey/hotkey.lua строка 165

Методы

delete
Signature hs.hotkey:delete()
Type Метод
Description

Деактивирует и удаляет объект комбинации клавиш

Parameters
  • Никаких
Returns
  • Никаких
Source extensions/hotkey/hotkey.lua строка 108
disable
Signature hs.hotkey:disable() -> hs.hotkey object
Type Метод
Description

Деактивирует объект комбинации клавиш

Parameters
  • Никаких
Returns
  • Объект hs.hotkey для цепочки методов
Source extensions/hotkey/hotkey.lua строка 82
enable
Signature hs.hotkey:enable() -> hs.hotkey object | nil
Type Метод
Description

Активирует объект комбинации клавиш

Parameters
  • Никаких
Returns
  • Объект hs.hotkey для цепочки методов или nil, если комбинация клавиш не может быть активирована по какой-либо причине.
Notes
  • При активации комбинации клавиш, использующей ту же комбинацию, что и ранее активированная, предыдущая комбинация перестанет работать, так как она «затенена» новой. Как только новая комбинация будет деактивирована или удалена, предыдущая снова начнёт работать.
Source extensions/hotkey/hotkey.lua строка 40

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API