hs.mouse

Просмотр/манипулирование положением курсора мыши

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

В этом модуле используется ManyMouse от Ryan C. Gordon.

ЛИЦЕНЗИЯ MANYMOUSE:

Данное программное обеспечение предоставляется "как есть", без каких-либо явных или подразумеваемых гарантий. В никоём случае авторы не несут ответственности за любые убытки, возникшие в результате использования этого программного обеспечения.

Любому разрешается использовать это программное обеспечение для любых целей, включая коммерческие, а также изменять и свободно перераспределять его при соблюдении следующих ограничений:

Источник этого программного обеспечения не должен быть искажён; вы не должны

утверждать, что вы написали исходное программное обеспечение. Если вы используете это программное обеспечение в продукте, благодарность в документации продукта будет оценена, но не является обязательной.

Изменённые версии исходного кода должны быть чётко помечены как таковые и не должны

искажаться как исходное программное обеспечение.

Это уведомление не может быть удалено или изменено из любого дистрибутива исходного кода.

Ryan C. Gordon icculus@icculus.org

Обзор API

Функции - API-вызовы, предлагаемые непосредственно расширением

absolutePosition
count
currentCursorType
getButtons
getCurrentScreen
getRelativePosition
names
scrollDirection
setRelativePosition
trackingSpeed

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

Функции

absolutePosition

Подпись	`hs.mouse.absolutePosition([point]) -> point`
Тип	Функция
Описание	Получение или установка абсолютных координат курсора мыши
Параметры	Необязательная таблица точек, содержащая абсолютные координаты x и y для перемещения курсора мыши
Возвращаемое значение	Таблица точек, содержащая абсолютные координаты x и y курсора мыши
Примечания	Если параметры не заданы, возвращается текущее положение. Если задан параметр таблицы точек, положение курсора мыши будет установлено, и будут возвращены новые координаты
Источник	extensions/mouse/libmouse.m строка 202

count

Подпись	`hs.mouse.count([includeInternal]) -> number`
Тип	Функция
Описание	Получение общего количества мышей, подключенных к вашей системе.
Параметры	includeInternal - Булево значение, определяющее, нужно ли включать внутренние трекпады в счёт. По умолчанию false.
Возвращаемое значение	Количество мышей, подключенных к вашей системе
Примечания	Эта функция использует код из ManyMouse. Эта функция считает любую мышь, помеченную как «Apple Internal Keyboard / Trackpad», внутренней мышью.
Источник	extensions/mouse/libmouse.m строка 154

currentCursorType

Подпись	`hs.mouse.currentCursorType() -> string`
Тип	Функция
Описание	Получение идентификатора текущего типа курсора мыши.
Параметры	Нет
Возвращаемое значение	Строка.
Примечания	Возможные значения включают: arrowCursor, contextualMenuCursor, closedHandCursor, crosshairCursor, disappearingItemCursor, dragCopyCursor, dragLinkCursor, IBeamCursor, operationNotAllowedCursor, pointingHandCursor, resizeDownCursor, resizeLeftCursor, resizeLeftRightCursor, resizeRightCursor, resizeUpCursor, resizeUpDownCursor, IBeamCursorForVerticalLayout или unknown, если тип курсора определить невозможно. Эта функция также может возвращать daVinciResolveHorizontalArrows при наведении курсора на перетаскиваемые текстовые поля в DaVinci Resolve. Это определяется с помощью значения "горячей точки" курсора.
Источник	extensions/mouse/libmouse.m строка 274

getButtons

Подпись	`hs.mouse.getButtons() -> table`
Тип	Функция
Описание	Возвращает таблицу, содержащую нажатые в данный момент кнопки мыши.
Параметры	Нет
Возвращаемое значение	Возвращает массив, содержащий индексы от 1 до наибольшего номера нажатой кнопки, где индекс — `true` если кнопка нажата, или `false` если нет. Также устанавливаются специальные синонимы тегов для `left` (кнопка 1), `right` (кнопка 2) и `middle` (кнопка 3), если эти кнопки нажаты.
Примечания	Эта функция является обёрткой для `hs.eventtap.checkMouseButtons` Это мгновенный запрос текущих кнопок мыши, а не обратный вызов.
Источник	extensions/mouse/mouse.lua строка 154

getCurrentScreen

Подпись	`hs.mouse.getCurrentScreen() -> screen or nil`
Тип	Функция
Описание	Получение экрана, на котором находится курсор мыши
Параметры	Нет
Возвращаемое значение	Объект `hs.screen` экрана, на котором находится курсор мыши, или nil, если произошла ошибка
Источник	extensions/mouse/mouse.lua строка 140

getRelativePosition

Подпись	`hs.mouse.getRelativePosition() -> point or nil`
Тип	Функция
Описание	Получение координат курсора мыши относительно экрана, на котором он находится
Параметры	Нет
Возвращаемое значение	Таблица точек, содержащая относительные координаты x и y курсора мыши, или nil, если произошла ошибка
Примечания	Координаты, возвращаемые этой функцией, относятся к верхнему левому пикселю экрана, на котором находится мышь (см. `hs.mouse.getAbsolutePosition` если вам нужно расположение в полном пространстве рабочего стола)
Источник	extensions/mouse/mouse.lua строка 84

names

Подпись	`hs.mouse.names() -> table`
Тип	Функция
Описание	Получение названий подключенных к системе мышей.
Параметры	Нет
Возвращаемое значение	Таблица, содержащая строки со всеми подключенными к системе мышами.
Примечания	Эта функция использует код из ManyMouse.
Источник	extensions/mouse/libmouse.m строка 182

scrollDirection

Подпись	`hs.mouse.scrollDirection() -> string`
Тип	Функция
Описание	Получение системного направления прокрутки
Параметры	Нет
Возвращаемое значение	Строка, либо "natural", либо "normal"
Источник	extensions/mouse/libmouse.m строка 257

setRelativePosition

Подпись	`hs.mouse.setRelativePosition(point[, screen])`
Тип	Функция
Описание	Установка координат курсора мыши, относительных к экрану
Параметры	point - Таблица точек, содержащая относительные координаты x и y для перемещения курсора мыши screen - Необязательный объект `hs.screen`. По умолчанию используется экран, на котором находится курсор мыши
Возвращаемое значение	Нет
Источник	extensions/mouse/mouse.lua строка 112

скорость отслеживания

Подпись	`hs.mouse.trackingSpeed([speed]) -> number`
Тип	Функция
Описание	Получение/установка текущей настройки скорости отслеживания курсора мыши
Параметры	speed - Необязательное число, содержащее новую скорость отслеживания для установки. Если этот параметр опущен, возвращается текущее значение
Возвращаемое значение	Число, указывающее текущую настройку скорости отслеживания мыши
Примечания	Это представлено в настройках системы как настройка "Скорость отслеживания" для мыши Обратите внимание, что не все значения будут работать, они должны соответствовать шагам, определённым в приложении "Системные настройки": 0.0, 0.125, 0.5, 0.6875, 0.875, 1.0, 1.5, 2.0, 2.5, 3.0 Обратите внимание, что изменения этого значения не будут сразу заметны в macOS
Источник	extensions/mouse/libmouse.m строка 227