Plugin:MirLua/ru/m hotkeys - Revision history

Dart Raiden at 21:19, 5 November 2021

2021-11-05T21:19:52Z

← Older revision		Revision as of 00:19, 6 November 2021
Line 1:		Line 1:
	{{PageLang\|ru}}		{{PageLang\|ru}}
	Предоставляет ~~функционал~~ для работы с комбинациями клавиш.		Предоставляет функциональность для работы с комбинациями клавиш.

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

Unsane: /* MakeHotkey */

2017-09-02T18:26:36Z

MakeHotkey

← Older revision		Revision as of 21:26, 2 September 2017
Line 48:		Line 48:
	\|-		\|-
	!Описание		!Описание
	\|код клавиш-модификаторов\|\|название клавиши-модификатора\|\|список названий клавиш-модификаторов		\|код клавиш-модификаторов
			\|название клавиши-модификатора
			\|список названий клавиш-модификаторов
	\|-		\|-
	!~~Допустимые значения~~		!Значения
	\|		\|
	*shift = 0x01		*shift = 0x01
Line 56:		Line 58:
	*alt = 0x04		*alt = 0x04
	*win = 0x08		*win = 0x08
	\|		\|colspan="2"\|
	*ctrl
	*shift
	*alt
	*ext
	\|
	*ctrl		*ctrl
	*shift		*shift

Unsane: /* MakeHotkey */

2017-09-02T18:23:54Z

MakeHotkey

← Older revision		Revision as of 21:23, 2 September 2017
Line 57:		Line 57:
	*win = 0x08		*win = 0x08
	\|		\|
	*'ctrl'		*ctrl
	*'shift'		*shift
	*'alt'		*alt
	*'ext'		*ext
	\|		\|
	*'ctrl'		*ctrl
	*'shift'		*shift
	*'alt'		*alt
	*'ext'		*ext
	\|}		\|}
	: '''''key'''''		: '''''key'''''

Unsane: /* MakeHotkey */

2017-09-02T18:22:59Z

MakeHotkey

← Older revision		Revision as of 21:22, 2 September 2017
Line 41:		Line 41:
	Создает комбинацию клавиш.		Создает комбинацию клавиш.
	;Параметры		;Параметры
	: '''''modifier'''''		:'''''modifier'''''
	:: Тип: '''number'''		::
	~~:: Код~~ клавиш-модификаторов:		{\| class="wikitable"
	~~:::~~ shift = 0x01		!Тип
	~~:::~~ control = 0x02		\|'''number'''\|\|'''string'''\|\|'''table'''
	~~:::~~ alt = 0x04		\|-
	~~:::~~ win = 0x08		!Описание
			\|код клавиш-модификаторов\|\|название клавиши-модификатора\|\|список названий клавиш-модификаторов
			\|-
			!Допустимые значения
			\|
			*shift = 0x01
			*control = 0x02
			*alt = 0x04
			*win = 0x08
			\|
			*'ctrl'
			*'shift'
			*'alt'
			*'ext'
			\|
			*'ctrl'
			*'shift'
			*'alt'
			*'ext'
			\|}
	: '''''key'''''		: '''''key'''''
	:: Тип: '''string'''		:: Тип: '''string'''
Line 54:		Line 73:
	: Тип: '''number'''		: Тип: '''number'''
	: Возвращает комбинацию клавиш.		: Возвращает комбинацию клавиш.
	;~~Пример~~		;Примеры
	{{Content:MirLua/Example\|code=		{{Content:MirLua/Example\|code=
	local HOTKEYF_SHIFT = 0x01		local HOTKEYF_SHIFT = 0x01
Line 60:		Line 79:
	local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')		local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')
	}}		}}
			{{Content:MirLua/Example\|code=
			local hk = hotkeys.MakeHotkey('ctrl', 'A')
			}}
			{{Content:MirLua/Example\|code=
			local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')
			}}

	== Структуры ==		== Структуры ==

RMN: Plugin:MirLua/ru/m_hotkeys

2015-12-25T22:39:56Z

Plugin:MirLua/ru/m_hotkeys

New page

{{PageLang|ru}}
Предоставляет функционал для работы с комбинациями клавиш.

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

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Функции ==
=== Register ===
Регистрирует комбинацию клавиш.
;Параметры
: '''''data'''''
:: Тип: '''table'''
:: Таблица [[#HotkeyItem|HotkeyItem]].
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false'''.
;Пример
{{Content:MirLua/Example|code=
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })
}}

=== Unregister ===
Удаляет комбинацию клавиш.
;Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя комбинации клавиш.
;Результат
: Тип: '''boolean'''
: Возвращает '''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=
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'''
:: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|Комбинация клавиш]] по умолчанию.
: ''Service''
:: Тип: '''string'''
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]].
: ''Flags''
:: Тип: '''number'''
:: Дополнительные флаги.

[[Category:Руководства]]