Spec-Zone.ru › Hammerspoon

hs.eventtap

Получайте события ввода (мышь, клавиатура, трекпад) для наблюдения и, возможно, их переопределения. Также предоставляет удобные обертки для отправки событий мыши и клавиатуры. Если вам нужно создавать точно настраиваемые события мыши/клавиатуры, обратитесь к hs.eventtap.event

Этот модуль в основном основан на коде из предыдущей версии Mjolnir от Steven Degutis.

Подмодули

  • hs.eventtap.event

Обзор API

  • Функции — вызовы API, предлагаемые непосредственно расширением
    • checkKeyboardModifiers
    • checkMouseButtons
    • doubleClickInterval
    • isSecureInputEnabled
    • keyRepeatDelay
    • keyRepeatInterval
    • keyStroke
    • keyStrokes
    • leftClick
    • middleClick
    • otherClick
    • rightClick
    • scrollWheel
  • Конструкторы — вызовы API, возвращающие объект, обычно предлагающий методы API
    • new
  • Методы — вызовы API, которые могут быть выполнены только с объектом, возвращенным конструктором
    • isEnabled
    • start
    • stop

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

Функции

checkKeyboardModifiers
Подпись hs.eventtap.checkKeyboardModifiers([raw]) -> table
Тип Функция
Описание

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

Параметры
  • raw - необязательное булево значение, которое, если равно true, включает _raw ключ, содержащий числовое представление всех флагов клавиатуры/модификаторов.
Возвращаемое значение
  • Возвращает таблицу, содержащую булевы значения, указывающие, какие модификаторы клавиш были нажаты при вызове функции; Возможные клавиши:
    • cmd (или ⌘)
    • alt (или ⌥)
    • shift (или ⇧)
    • ctrl (или ⌃)
    • capslock
    • fn

и необязательно * _raw - числовое представление числового представления всех флагов клавиатуры/модификаторов.

Примечания
  • Это мгновенный запрос текущих модификаторов клавиш для последней использованной клавиатуры, а не обратный вызов. Это полезно в основном в сочетании с другими модулями, такими как hs.menubar, когда обратный вызов уже выполняется или ожидание обратного вызова события непрактично или невозможно.
  • Возвращаемое числовое значение полезно, если вам нужно обнаруживать зависящие от устройства флаги или флаги, которые мы обычно игнорируем, потому что они отсутствуют (или доступны другим способом) на большинстве клавиатур.
Источник extensions/eventtap/libeventtap.m строка 276
checkMouseButtons
Подпись hs.eventtap.checkMouseButtons() -> table
Тип Функция
Описание

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

Параметры
  • Нет
Возвращаемое значение
  • Возвращает массив, содержащий индексы от 1 до наибольшего номера нажатой кнопки в данный момент, где индекс — true если кнопка нажата, или false если нет.
  • Специальные синонимы хэштегов для left (кнопка 1), right (кнопка 2) и middle (кнопка 3) также устанавливаются в true, если эти кнопки нажаты.
Примечания
  • Это мгновенный запрос текущих кнопок мыши, а не обратный вызов. Это полезно в основном в сочетании с другими модулями, такими как hs.menubar, когда обратный вызов уже выполняется или ожидание обратного вызова события непрактично или невозможно.
Источник extensions/eventtap/libeventtap.m строка 353
doubleClickInterval
Подпись hs.eventtap.doubleClickInterval() -> number
Тип Функция
Описание

Возвращает системное значение задержки между двумя щелчками для регистрации события двойного щелчка.

Параметры
  • Нет
Возвращаемое значение
  • Число, содержащее максимальное количество секунд между двумя событиями щелчка мыши для регистрации события двойного щелчка.
Источник extensions/eventtap/libeventtap.m строка 422
isSecureInputEnabled
Подпись hs.eventtap.isSecureInputEnabled() -> boolean
Тип Функция
Описание

Проверяет, предотвращает ли macOS отправку событий клавиатуры в обработчики событий.

Параметры
  • Нет
Возвращаемое значение
  • Булево значение, true, если защита ввода включена, иначе false
Примечания
  • Если защита ввода включена, Hammerspoon не может перехватывать события клавиатуры.
  • Защита ввода обычно включается только в ситуациях, когда поле пароля выделено в веб-браузере, системном диалоговом окне или терминале.
Источник extensions/eventtap/libeventtap.m строка 330
keyRepeatDelay
Подпись hs.eventtap.keyRepeatDelay() -> number
Тип Функция
Описание

Возвращает системное значение задержки, прежде чем начнутся события повторения нажатия клавиши.

Параметры
  • Нет
Возвращаемое значение
  • Число, содержащее количество секунд до начала событий повторения после удержания клавиши.
Источник extensions/eventtap/libeventtap.m строка 408
keyRepeatInterval
Подпись hs.eventtap.keyRepeatInterval() -> number
Тип Функция
Описание

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

Параметры
  • Нет
Возвращаемое значение
  • Число, содержащее количество секунд между событиями нажатия клавиши, если клавиша удерживается.
Источник extensions/eventtap/libeventtap.m строка 394
keyStroke
Подпись hs.eventtap.keyStroke(modifiers, character[, delay, application])
Тип Функция
Описание

Генерирует и отправляет пару событий одиночного нажатия клавиши для указанных модификаторов клавиш и символа.

Параметры
  • modifiers - Таблица, содержащая применяемые модификаторы клавиш ("fn", "ctrl", "alt", "cmd", "shift" или их эквиваленты Unicode)
  • character - Строка, содержащая символ, который нужно отправить.
  • delay - Необязательная задержка (в микросекундах) между событиями нажатия и отпускания клавиши. По умолчанию 200000 (т. е. 200 мс)
  • application - Необязательный объект hs.application для отправки нажатия клавиши.
Возвращаемое значение
  • Нет
Примечания
  • Эта функция идеально подходит для отправки одиночного нажатия клавиши с примененным модификатором (например, отправка ⌘-v для вставки с hs.eventtap.keyStroke({"cmd"}, "v")). Если вы хотите отправлять несколько нажатий клавиш для ввода строк текста, обратитесь к hs.eventtap.keyStrokes()
  • Обратите внимание, что вызов этой функции с таблицей (пустой или другой) для аргумента modifiers заставит отпустить любые модификаторы клавиш, которые были явно созданы с помощью hs.eventtap.event.newKeyEvent и отправлены, которые все еще находятся в состоянии "down". Явное nil для этого аргумента не будет (т. е. нажатие клавиши унаследует любые текущие модификаторы "down")
Источник extensions/eventtap/eventtap.lua строка 242
keyStrokes
Подпись hs.eventtap.keyStrokes(text[, application])
Тип Функция
Описание

Генерирует и отправляет события нажатия клавиш для указанного текста.

Параметры
  • text - Строка, содержащая текст, который нужно набрать.
  • application - Необязательный объект hs.application для отправки нажатий клавиш.
Возвращаемое значение
  • Нет
Примечания
  • Если вы хотите отправить одиночное нажатие клавиши с модификаторами клавиатуры (например, отправка ⌘-v для вставки), см. hs.eventtap.keyStroke()
Источник extensions/eventtap/libeventtap.m строка 81
leftClick
Подпись hs.eventtap.leftClick(point[, delay])
Тип Функция
Описание

Генерирует событие левого щелчка мыши в указанной точке

Параметры
  • point - Таблица с ключами {x, y} , указывающая местоположение, где должно произойти событие мыши
  • delay - Необязательная задержка (в микросекундах) между событиями нажатия и отпускания мыши. По умолчанию 200000 (т.е. 200 мс)
Возвращаемое значение
  • None
Примечания
  • Это обёртка вокруг hs.eventtap.event.newMouseEvent , которая отправляет события leftmousedown и leftmouseup
Источник extensions/eventtap/eventtap.lua строка 147
middleClick
Подпись hs.eventtap.middleClick(point[, delay])
Тип Функция
Описание

Генерирует событие среднего щелчка мыши в указанной точке

Параметры
  • point - Таблица с ключами {x, y} , указывающая местоположение, где должно произойти событие мыши
  • delay - Необязательная задержка (в микросекундах) между событиями нажатия и отпускания мыши. По умолчанию 200000 (т.е. 200 мс)
Возвращаемое значение
  • None
Примечания
  • Эта функция просто обёртка, вызывающая hs.eventtap.otherClick(point, delay, 2) , и включена исключительно для обратной совместимости.
Источник extensions/eventtap/eventtap.lua строка 225
otherClick
Подпись hs.eventtap.otherClick(point[, delay][, button])
Тип Функция
Описание

Генерирует событие "другого" щелчка мыши в указанной точке

Параметры
  • point - Таблица с ключами {x, y} , указывающая местоположение, где должно произойти событие мыши
  • delay - Необязательная задержка (в микросекундах) между событиями нажатия и отпускания мыши. По умолчанию 200000 (т.е. 200 мс)
  • button - Необязательное целое число, по умолчанию 2, от 2 до 31, определяющее номер нажимаемой кнопки. Если этот параметр указан, то параметр delay также должен быть указан, хотя его можно указать как nil для использования по умолчанию.
Возвращаемое значение
  • None
Примечания
  • Это обёртка вокруг hs.eventtap.event.newMouseEvent , которая отправляет события otherMouseDown и otherMouseUp
  • macOS распознает до 32 различных кнопок мыши, хотя у немногих устройств их больше 3. Левая кнопка мыши соответствует номеру кнопки 0, правая - 1; для этих кнопок используются отдельные события, поэтому для них следует использовать hs.eventtap.leftClick и hs.eventtap.rightClick соответственно. Все остальные кнопки мыши объединяются в события otherMouse и различаются указанием конкретной кнопки с помощью свойства mouseEventButtonNumber , что делает эта функция за вас.
  • Конкретное назначение кнопок мыши, больших 2, зависит от аппаратного обеспечения и приложения (обычно они отсутствуют на мыши и не влияют на приложение)
Источник extensions/eventtap/eventtap.lua строка 193
rightClick
Подпись hs.eventtap.rightClick(point[, delay])
Тип Функция
Описание

Генерирует событие правого щелчка мыши в указанной точке

Параметры
  • point - Таблица с ключами {x, y} , указывающая местоположение, где должно произойти событие мыши
  • delay - Необязательная задержка (в микросекундах) между событиями нажатия и отпускания мыши. По умолчанию 200000 (т.е. 200 мс)
Возвращаемое значение
  • None
Примечания
  • Это обёртка вокруг hs.eventtap.event.newMouseEvent , которая отправляет события rightmousedown и rightmouseup
Источник extensions/eventtap/eventtap.lua строка 170
scrollWheel
Подпись hs.eventtap.scrollWheel(offsets, modifiers, unit) -> event
Тип Функция
Описание

Генерирует и отправляет событие прокрутки колесика мыши

Параметры
  • offsets - Таблица, содержащая {горизонтальное, вертикальное} количество прокрутки. Положительные значения прокручивают вверх или влево, отрицательные - вниз или вправо.
  • mods - Таблица, содержащая ноль или более из следующего:
    • cmd
    • alt
    • shift
    • ctrl
    • fn
  • unit - Необязательная строка, содержащая имя единицы измерения для прокрутки. Либо "line" (по умолчанию), либо "pixel"
Возвращаемое значение
  • None
Источник extensions/eventtap/eventtap.lua строка 281

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

new
Подпись hs.eventtap.new(types, fn) -> eventtap
Тип Конструктор
Описание

Создаёт новый объект захвата событий

Параметры
  • types - Таблица, которая должна содержать значения из hs.eventtap.event.types
  • fn - Функция, которая будет вызываться при возникновении указанных типов событий. Функция должна принимать один параметр, который будет объектом события. Она может необязательно вернуть два значения. Во-первых, логическое значение, true, если событие должно быть удалено, false, если оно должно распространиться на другие приложения, отслеживающие это событие. Во-вторых, таблицу событий для отправки.
Возвращаемое значение
  • Объект захвата событий
Примечания
  • Если вы укажете аргумент types как специальную таблицу {"all"[, события для игнорирования]}, то все события (кроме тех, которые вы необязательно перечислите после строки "all") будут вызывать обратный вызов, даже те, которые не определены в Справочнике по событиям Quartz.
Источник extensions/eventtap/libeventtap.m строка 146

Методы

isEnabled
Подпись hs.eventtap:isEnabled() -> bool
Тип Метод
Описание

Определяет, включён ли объект захвата событий.

Параметры
  • None
Возвращаемое значение
  • True, если захват событий включён, или false, если нет.
Источник extensions/eventtap/libeventtap.m строка 261
start
Подпись hs.eventtap:start()
Тип Метод
Описание

Запускает захват событий

Параметры
  • None
Возвращаемое значение
  • Объект захвата событий
Источник extensions/eventtap/libeventtap.m строка 196
stop
Подпись hs.eventtap:stop()
Тип Метод
Описание

Останавливает захват событий

Параметры
  • None
Возвращаемое значение
  • Объект захвата событий
Источник extensions/eventtap/libeventtap.m строка 236

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

Spec-Zone.ru

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