Plugin:MirLua/Module/m hotkeys: Difference between revisions
Jump to navigation
Jump to search
(Plugin:MirLua/en/m_hotkeys (from ru)) |
(Marked this version for translation) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages/> | |||
<translate> | |||
<!--T:1--> | |||
Allows you to work with key combinations. | Allows you to work with key combinations. | ||
</translate> | |||
{{Ls|MirLua/Modules/include_info}} <code>local hotkeys = require('m_hotkeys')</code> | |||
__TOC__ | |||
<translate> | |||
== Functions == <!--T:2--> | |||
</translate> | |||
=== Register === | |||
<translate><!--T:3--> Registers a key combination.</translate> | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
{| class="wikitable" | |||
|- | |||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|Content/TableHeaders/type}} | |||
! scope="col" | {{Ls|Content/TableHeaders/description}} | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | data | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>table</code> | |||
| <translate><!--T:4--> <tvar|HotkeyItem>[[#HotkeyItem|HotkeyItem]]</> table.</translate> | |||
|} | |||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | |||
{{nbsp|5}}<translate><!--T:5--> Returns <tvar|true><code>true</code></> if key combination was registered successfully, otherwise <tvar|false><code>false</code></>.</translate> | |||
== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
=== | |||
{{Content:MirLua/Example|code= | {{Content:MirLua/Example|code= | ||
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' }) | local hIcon = hotkeys.Register({ Name = 'hkUniqueName' }) | ||
}} | }} | ||
---- | |||
=== Unregister === | === Unregister === | ||
Removes a key combination. | <translate><!--T:6--> Removes a key combination.</translate> | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
:: | {| class="wikitable" | ||
: | |- | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
: Returns | ! scope="col" | {{Ls|Content/TableHeaders/type}} | ||
! scope="col" | {{Ls|Content/TableHeaders/description}} | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | name | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>string</code> | |||
| <translate><!--T:7--> Key combination name.</translate> | |||
|} | |||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | |||
{{nbsp|5}}<translate><!--T:8--> Returns <tvar|true><code>true</code></> if key combination was removed successfully, otherwise <tvar|false><code>false</code></>.</translate> | |||
==== {{Ls|MirLua/Modules/example}} ==== | |||
{{Content:MirLua/Example|code= | {{Content:MirLua/Example|code= | ||
hotkeys.Unregister('hkUniqueName') | hotkeys.Unregister('hkUniqueName') | ||
}} | }} | ||
---- | |||
=== MakeHotkey === | === MakeHotkey === | ||
Creates key combination. | <translate><!--T:9--> Creates key combination.</translate> | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
:: | {| class="wikitable" | ||
: | |- | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|Content/TableHeaders/type}} | |||
! scope="col" | {{Ls|Content/TableHeaders/description}} | |||
|- | |||
:: | ! scope="row" class="MirLuaParametersTable-parameter" | modifier | ||
: | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>number</code>, <code>string</code>, <code>table</code> | |||
| <translate><!--T:10--> Modifier key code or name or list of names. Takes values:</translate> | |||
: Returns key combination. | * shift = 0x01 | ||
* control = 0x02 | |||
* alt = 0x04 | |||
* win = 0x08 | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | key | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>string</code> | |||
| <translate><!--T:11--> Normal (non-modifier) key.</translate> | |||
|} | |||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code> | |||
{{nbsp|5}}<translate><!--T:12--> Returns key combination.</translate> | |||
==== {{Ls|MirLua/Modules/example}} ==== | |||
{{Content:MirLua/Example|code= | {{Content:MirLua/Example|code= | ||
local HOTKEYF_SHIFT = 0x01 | local HOTKEYF_SHIFT = 0x01 | ||
Line 61: | Line 107: | ||
}} | }} | ||
{{Content:MirLua/Example|code= | |||
local hk = hotkeys.MakeHotkey('ctrl', 'A') | |||
}} | |||
{{Content:MirLua/Example|code= | |||
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A') | |||
}} | |||
<translate> | |||
== Structures == <!--T:13--> | |||
</translate> | |||
=== HotkeyItem === | === HotkeyItem === | ||
A table describing key combination parameters. | <translate><!--T:14--> A table describing key combination parameters.</translate> | ||
[[ | ==== {{Ls|MirLua/Modules/fields}} ==== | ||
{| class="wikitable" | |||
|- | |||
! scope="col" | {{Ls|MirLua/Modules/field_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|Content/TableHeaders/type}} | |||
! scope="col" | {{Ls|Content/TableHeaders/description}} | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | Name | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>string</code> | |||
| <translate><!--T:15--> Name of key combination (automatically translated by Core).</translate> | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | Description | |||
| style="text-align:center" | {{Ls|YesNo/no}} | |||
| style="text-align:center" | <code>string</code> | |||
| <translate><!--T:16--> Description of key combination (automatically translated by Core).</translate> | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | Section | |||
| style="text-align:center" | {{Ls|YesNo/no}} | |||
| style="text-align:center" | <code>string</code> | |||
| <translate><!--T:17--> Section name in Miranda hotkey settings. By default plugin name (<tvar|MirLua>MirLua</>) is used.</translate> | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | Hotkey | |||
| style="text-align:center" | {{Ls|YesNo/no}} | |||
| style="text-align:center" | <code>number</code> | |||
| <translate><!--T:18--> Default [[<tvar|link>#MakeHotkey</>|key combination]].</translate> | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | Service | |||
| style="text-align:center" | {{Ls|YesNo/no}} | |||
| style="text-align:center" | <code>string</code> | |||
| [[Special:MyLanguage/Plugin:MirLua/Module/m_core#CreateServiceFunction|<translate><!--T:19--> Service name.</translate>]] | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | Flags | |||
| style="text-align:center" | {{Ls|YesNo/no}} | |||
| style="text-align:center" | <code>number</code> | |||
| <translate><!--T:20--> Additional flags.</translate> | |||
|} |
Latest revision as of 19:07, 2 June 2018
Allows you to work with key combinations.
Include module: local hotkeys = require('m_hotkeys')
Functions
Register
Registers a key combination.
Parameters
Parameter name | Required | Type | Description |
---|---|---|---|
data | Yes | table
|
HotkeyItem table. |
Result
Type: boolean
Returns true
if key combination was registered successfully, otherwise false
.
Example
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })
Unregister
Removes a key combination.
Parameters
Parameter name | Required | Type | Description |
---|---|---|---|
name | Yes | string
|
Key combination name. |
Result
Type: boolean
Returns true
if key combination was removed successfully, otherwise false
.
Example
hotkeys.Unregister('hkUniqueName')
MakeHotkey
Creates key combination.
Parameters
Parameter name | Required | Type | Description |
---|---|---|---|
modifier | Yes | number , string , table
|
Modifier key code or name or list of names. Takes values:
|
key | Yes | string
|
Normal (non-modifier) key. |
Result
Type: number
Returns key combination.
Example
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')
Structures
HotkeyItem
A table describing key combination parameters.
Fields
Field name | Required | Type | Description |
---|---|---|---|
Name | Yes | string
|
Name of key combination (automatically translated by Core). |
Description | No | string
|
Description of key combination (automatically translated by Core). |
Section | No | string
|
Section name in Miranda hotkey settings. By default plugin name (MirLua) is used. |
Hotkey | No | number
|
Default key combination. |
Service | No | string
|
Service name. |
Flags | No | number
|
Additional flags. |