User:Unsane/MirLua/m hotkeys: Difference between revisions
Jump to navigation
Jump to search
(Created page with "Предоставляет функционал для работы с комбинациями клавиш. Подключение модуля: local hotkeys = require('m_...") |
mNo edit summary |
||
| Line 3: | Line 3: | ||
==Функции== | ==Функции== | ||
===MakeHotkey=== | |||
Создает комбинацию клавиш | |||
;Параметры | |||
: '''''modifier''''' | |||
:: Тип: '''number''' | |||
:: Код клавиш-модификаторов (ctrl, alt и т.д.) | |||
: '''''vKey''''' | |||
:: Тип: '''number''' | |||
:: Код виртуальной клавиши | |||
;Результат | |||
: Тип: '''number''' | |||
: Возвращает комбинацию клавиш | |||
;Пример | |||
{{Content:MirLua/Example|code= | |||
local hIcon = hotkeys.MakeHotkey() | |||
}} | |||
===Register=== | ===Register=== | ||
Регистрирует комбинацию клавиш | Регистрирует комбинацию клавиш | ||
;Параметры | ;Параметры | ||
: ''''' | : '''''data''''' | ||
:: Тип: '''table''' | :: Тип: '''table''' | ||
:: Таблица [[#HotkeyDesc|HotkeyDesc]] | :: Таблица [[#HotkeyDesc|HotkeyDesc]] | ||
;Результат | ;Результат | ||
: Тип: '''boolean''' | : Тип: '''boolean''' | ||
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе ''' | : Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false''' | ||
;Пример | |||
{{Content:MirLua/Example|code= | |||
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' }) | |||
}} | |||
===Unregister=== | |||
Удаляет комбинацию клавиш | |||
;Параметры | |||
: '''''name''''' | |||
:: Тип: '''string''' | |||
:: Имя комбинации клавиш | |||
;Результат | |||
: Тип: '''boolean''' | |||
: Возвращает '''true''', если комбинация клавиш удалена, иначе '''false''' | |||
;Пример | ;Пример | ||
{{Content:MirLua/Example|code= | {{Content:MirLua/Example|code= | ||
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' } | local hIcon = hotkeys.Register({ Name = 'hkUniqueName' }) | ||
}} | }} | ||
| Line 32: | Line 63: | ||
: ''Hotkey'' | : ''Hotkey'' | ||
:: Тип: '''number''' | :: Тип: '''number''' | ||
:: | :: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|комбинация клавиш]] по умолчанию | ||
: ''Service'' | : ''Service'' | ||
:: Тип: '''string''' | :: Тип: '''string''' | ||
Revision as of 18:48, 22 December 2015
Предоставляет функционал для работы с комбинациями клавиш. Подключение модуля: local hotkeys = require('m_hotkeys')
Функции
MakeHotkey
Создает комбинацию клавиш
- Параметры
- modifier
- Тип: number
- Код клавиш-модификаторов (ctrl, alt и т.д.)
- vKey
- Тип: number
- Код виртуальной клавиши
- Результат
- Тип: number
- Возвращает комбинацию клавиш
- Пример
local hIcon = hotkeys.MakeHotkey()Register
Регистрирует комбинацию клавиш
- Параметры
- data
- Тип: table
- Таблица HotkeyDesc
- Результат
- Тип: boolean
- Возвращает true, если комбинация клавиш зарегистрирована, иначе false
- Пример
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })Unregister
Удаляет комбинацию клавиш
- Параметры
- name
- Тип: string
- Имя комбинации клавиш
- Результат
- Тип: boolean
- Возвращает true, если комбинация клавиш удалена, иначе false
- Пример
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })Структуры
HotkeyDesc
Таблица, описывающая параметры комбинации клавиш
- Поля
- Name
- Тип: string
- Имя комбинации клавиш (автоматически переводится ядром)
- Description
- Тип: string
- Описание комбинации клавиш (автоматически переводится ядром)
- Section
- Тип: string
- Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)
- Hotkey
- Тип: number
- комбинация клавиш по умолчанию
- Service
- Тип: string
- Имя сервиса
- Flags
- Тип: number
- Дополнительные флаги