Spec-Zone.ru › Hammerspoon

hs.keycodes

Преобразует между строками клавиш и кодами клавиш. Также предоставляет функциональность для запроса и изменения раскладок клавиатуры.

Обзор API

  • Константы - Полезные значения, которые нельзя изменить
    • map
  • Функции - API-вызовы, предлагаемые непосредственно расширением
    • currentLayout
    • currentLayoutIcon
    • currentMethod
    • currentSourceID
    • iconForLayoutOrMethod
    • inputSourceChanged
    • layouts
    • methods
    • setLayout
    • setMethod

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

Константы

map
Подпись hs.keycodes.map
Тип Константа
Описание

Сопоставление между строковым представлением клавиши и её кодом, и наоборот.

Примечания
  • Например: keycodes[1] == "s", и keycodes["s"] == 1, и так далее.
  • В основном используется расширениями hs.eventtap и hs.hotkey.
  • Допустимые строки — это любая строка с одним символом или любая из следующих строк:
  • f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15,
  • f16, f17, f18, f19, f20, pad., pad*, pad+, pad/, pad-, pad=,
  • pad0, pad1, pad2, pad3, pad4, pad5, pad6, pad7, pad8, pad9,
  • padclear, padenter, return, tab, space, delete, escape, help,
  • home, pageup, forwarddelete, end, pagedown, left, right, down, up,
  • shift, rightshift, cmd, rightcmd, alt, rightalt, ctrl, rightctrl,
  • capslock, fn
Источник extensions/keycodes/keycodes.lua строка 67

Функции

currentLayout
Подпись hs.keycodes.currentLayout() -> string
Тип Функция
Описание

Получает имя текущей раскладки клавиатуры

Параметры
  • Нет
Возвращаемое значение
  • Строка, содержащая имя текущей раскладки клавиатуры
Источник extensions/keycodes/libkeycodes.m строка 370
currentLayoutIcon
Подпись hs.keycodes.currentLayoutIcon() -> hs.image object
Тип Функция
Описание

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

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.image, содержащий значок, если он доступен
Источник extensions/keycodes/libkeycodes.m строка 387
currentMethod
Подпись hs.keycodes.currentMethod() -> string
Тип Функция
Описание

Получить текущий метод ввода

Параметры
  • Нет
Возвращаемое значение
  • Имя текущего метода ввода или nil
Источник extensions/keycodes/libkeycodes.m строка 472
currentSourceID
Подпись hs.keycodes.currentSourceID([sourceID]) -> string | boolean
Тип Функция
Описание

Получить или установить идентификатор источника для источника ввода клавиатуры

Параметры
  • sourceID — необязательная строка, определяющая источник ввода для установки ввода с клавиатуры
Возвращаемое значение
  • Если параметр не указан, возвращает строку, содержащую идентификатор источника для текущей раскладки клавиатуры или метода ввода; если параметр указан, возвращает true или false, указывающие, удалось ли изменить источник ввода.
Источник extensions/keycodes/libkeycodes.m строка 334
iconForLayoutOrMethod
Подпись hs.keycodes.iconForLayoutOrMethod(sourceName) -> hs.image object
Тип Функция
Описание

Получает объект hs.image для заданной раскладки клавиатуры или метода ввода

Параметры
  • sourceName — строка, содержащая имя метода ввода или раскладки клавиатуры
Возвращаемое значение
  • Объект hs.image или nil, если значок не был найден
Примечания
  • Не все раскладки/методы имеют значки, поэтому следует исходить из того, что в какой-то момент будет возвращено значение nil
Источник extensions/keycodes/libkeycodes.m строка 566
inputSourceChanged
Подпись hs.keycodes.inputSourceChanged(fn)
Тип Функция
Описание

Устанавливает функцию, которая будет вызываться при изменении вашего источника ввода (например, qwerty, dvorak, colemac).

Параметры
  • fn — функция, которая будет вызываться при изменении источника ввода. Функции не передаются аргументы.
Возвращаемое значение
  • Нет
Примечания
  • Это может быть полезно для переназначения горячих клавиш на соответствующие клавиши в новой раскладке
  • Установка этого значения приведет к отмене функций, ранее зарегистрированных с помощью этой функции.
Источник extensions/keycodes/keycodes.lua строка 87
layouts
Подпись hs.keycodes.layouts([sourceID]) -> table
Тип Функция
Описание

Получает все включенные раскладки клавиатуры, на которые можно переключить источник ввода клавиатуры

Параметры
  • sourceID — необязательный булево значение, по умолчанию false, указывающее, следует ли возвращать имена раскладок клавиатуры (false) или их идентификаторы источника (true).
Возвращаемое значение
  • Таблица, содержащая список раскладок клавиатуры, включенных в Системных настройках
Примечания
  • В таблицу будут включены только те раскладки, на которые можно явно переключиться. Раскладки клавиатуры, которые являются частью методов ввода, не включаются. См. hs.keycodes.methods.
Источник extensions/keycodes/libkeycodes.m строка 404
methods
Подпись hs.keycodes.methods([sourceID]) -> table
Тип Функция
Описание

Получает все включенные методы ввода, на которые можно переключить источник ввода клавиатуры

Параметры
  • sourceID — необязательный булево значение, по умолчанию false, указывающее, следует ли возвращать имена методов ввода клавиатуры (false) или их идентификаторы источника (true).
Возвращаемое значение
  • Таблица, содержащая список методов ввода, включенных в Системных настройках
Примечания
  • Раскладки клавиатуры, которые не являются частью метода ввода, не включаются в эту таблицу. См. hs.keycodes.layouts.
Источник extensions/keycodes/libkeycodes.m строка 438
setLayout
Подпись hs.keycodes.setLayout(layoutName) -> boolean
Тип Функция
Описание

Изменяет системную раскладку клавиатуры

Параметры
  • layoutName — строка, содержащая имя включенной раскладки клавиатуры
Возвращаемое значение
  • Булево значение, true, если раскладка была успешно изменена, иначе false
Источник extensions/keycodes/libkeycodes.m строка 502
setMethod
Подпись hs.keycodes.setMethod(methodName) -> boolean
Тип Функция
Описание

Изменяет системный метод ввода

Параметры
  • methodName — строка, содержащая имя включенного метода ввода
Возвращаемое значение
  • Булево значение, true, если метод был успешно изменён, иначе false
Источник extensions/keycodes/libkeycodes.m строка 534

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

Spec-Zone.ru

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