User:Unsane/MirLua/m hotkeys: Difference between revisions
Jump to navigation
Jump to search
(Created page with "Предоставляет функционал для работы с комбинациями клавиш. Подключение модуля: local hotkeys = require('m_...") |
Dart Raiden (talk | contribs) No edit summary |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
Предоставляет | Предоставляет функциональность для работы с комбинациями клавиш.<br/> | ||
Подключение модуля: local hotkeys = require('m_hotkeys') | Подключение модуля: <code>local hotkeys = require('m_hotkeys')</code> | ||
==Функции== | ==Функции== | ||
===Register=== | ===Register=== | ||
Регистрирует комбинацию клавиш | Регистрирует комбинацию клавиш | ||
;Параметры | |||
: '''''data''''' | |||
:: Тип: '''table''' | |||
:: Таблица [[#HotkeyItem|HotkeyItem]] | |||
;Результат | |||
: Тип: '''boolean''' | |||
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false''' | |||
;Пример | |||
{{Content:MirLua/Example|code= | |||
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' }) | |||
}} | |||
===Unregister=== | |||
Удаляет комбинацию клавиш | |||
;Параметры | ;Параметры | ||
: '''''name''''' | : '''''name''''' | ||
:: Тип: ''' | :: Тип: '''string''' | ||
:: | :: Имя комбинации клавиш | ||
;Результат | ;Результат | ||
: Тип: '''boolean''' | : Тип: '''boolean''' | ||
: Возвращает '''true''', если комбинация клавиш | : Возвращает '''true''', если комбинация клавиш удалена, иначе '''false''' | ||
;Пример | |||
{{Content:MirLua/Example|code= | |||
hotkeys.Unregister('hkUniqueName') | |||
}} | |||
===MakeHotkey=== | |||
Создает комбинацию клавиш | |||
;Параметры | |||
: '''''modifier''''' | |||
:: Тип: '''number''' | |||
:: Код клавиш-модификаторов: | |||
::: shift = 0x01 | |||
::: control = 0x02 | |||
::: alt = 0x04 | |||
::: win = 0x08 | |||
: '''''key''''' | |||
:: Тип: '''string''' | |||
:: Символ | |||
;Результат | |||
: Тип: '''number''' | |||
: Возвращает комбинацию клавиш | |||
;Пример | ;Пример | ||
{{Content:MirLua/Example|code= | {{Content:MirLua/Example|code= | ||
local | local HOTKEYF_SHIFT = 0x01 | ||
local HOTKEYF_ALT = 0x04 | |||
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A') | |||
}} | }} | ||
== Структуры == | == Структуры == | ||
=== | ===HotkeyItem=== | ||
Таблица, описывающая параметры комбинации клавиш | Таблица, описывающая параметры комбинации клавиш | ||
;Поля | ;Поля | ||
Line 32: | Line 69: | ||
: ''Hotkey'' | : ''Hotkey'' | ||
:: Тип: '''number''' | :: Тип: '''number''' | ||
:: | :: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|комбинация клавиш]] по умолчанию | ||
: ''Service'' | : ''Service'' | ||
:: Тип: '''string''' | :: Тип: '''string''' |
Latest revision as of 00:20, 6 November 2021
Предоставляет функциональность для работы с комбинациями клавиш.
Подключение модуля: local hotkeys = require('m_hotkeys')
Функции
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
- Код клавиш-модификаторов:
- shift = 0x01
- control = 0x02
- alt = 0x04
- win = 0x08
- key
- Тип: string
- Символ
- Результат
- Тип: number
- Возвращает комбинацию клавиш
- Пример
local HOTKEYF_SHIFT = 0x01
local HOTKEYF_ALT = 0x04
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT | HOTKEYF_ALT, 'A')
Структуры
HotkeyItem
Таблица, описывающая параметры комбинации клавиш
- Поля
- Name
- Тип: string
- Имя комбинации клавиш (автоматически переводится ядром)
- Description
- Тип: string
- Описание комбинации клавиш (автоматически переводится ядром)
- Section
- Тип: string
- Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)
- Hotkey
- Тип: number
- комбинация клавиш по умолчанию
- Service
- Тип: string
- Имя сервиса
- Flags
- Тип: number
- Дополнительные флаги