Plugin:MirLua/ru/m hotkeys

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

Подключение модуля: local hotkeys = require('m_hotkeys')

<translate> Note</translate>
Параметры, выделенные жирным курсивом, являются обязательными.

Функции

Register

Регистрирует комбинацию клавиш.

Параметры

data

Тип: table

Таблица HotkeyItem.

Результат

Тип: boolean

Возвращает true, если комбинация клавиш зарегистрирована, иначе false.

Пример

local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })

Unregister

Удаляет комбинацию клавиш.

Параметры

name

Тип: string

Имя комбинации клавиш.

Результат

Тип: boolean

Возвращает true, если комбинация клавиш удалена, иначе false.

Пример

hotkeys.Unregister('hkUniqueName')

MakeHotkey

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

Параметры

modifier

Тип	number	string	table
Описание	код клавиш-модификаторов	название клавиши-модификатора	список названий клавиш-модификаторов
Значения	shift = 0x01 control = 0x02 alt = 0x04 win = 0x08	ctrl shift alt ext

key

Тип: string

Символ.

Результат

Тип: number

Возвращает комбинацию клавиш.

Примеры

local HOTKEYF_SHIFT = 0x01
local HOTKEYF_ALT = 0x04
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT | HOTKEYF_ALT, 'A')

local hk = hotkeys.MakeHotkey('ctrl', 'A')

local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')

Структуры

HotkeyItem

Таблица, описывающая параметры комбинации клавиш.

Поля

Name

Тип: string

Имя комбинации клавиш (автоматически переводится ядром).

Description

Тип: string

Описание комбинации клавиш (автоматически переводится ядром).

Section

Тип: string

Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (MirLua).

Hotkey

Тип: number

Комбинация клавиш по умолчанию.

Service

Тип: string

Имя сервиса.

Flags

Тип: number

Дополнительные флаги.