FuzzyBot: Updating to match new version of source page

2018-06-02T16:08:27Z

Updating to match new version of source page

New page

<languages/>
Allows you to work with key combinations.

{{Ls|MirLua/Modules/include_info}} <code>local hotkeys = require('m_hotkeys')</code>

__TOC__

== Functions ==

=== Register ===
Registers a key combination.

==== {{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>
| [[#HotkeyItem|HotkeyItem]] table.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> if key combination was registered successfully, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })
}}
----

=== Unregister ===
Removes a key combination.

==== {{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" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Key combination name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> if key combination was removed successfully, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
hotkeys.Unregister('hkUniqueName')
}}
----

=== MakeHotkey ===
Creates key combination.

==== {{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>
| Modifier key code or name or list of names. Takes values:
* 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>
| Normal (non-modifier) key.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>

{{nbsp|5}}Returns key combination.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
local HOTKEYF_SHIFT = 0x01
local HOTKEYF_ALT = 0x04
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')
}}

== Structures ==

=== HotkeyItem ===
A table describing key combination parameters.

==== {{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>
| Name of key combination (automatically translated by Core).
|-
! scope="row" class="MirLuaParametersTable-parameter" | Description
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| Description of key combination (automatically translated by Core).
|-
! scope="row" class="MirLuaParametersTable-parameter" | Section
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| Section name in Miranda hotkey settings. By default plugin name (MirLua) is used.
|-
! scope="row" class="MirLuaParametersTable-parameter" | Hotkey
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>number</code>
| Default [[#MakeHotkey|key combination]].
|-
! 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|Service name.]]
|-
! scope="row" class="MirLuaParametersTable-parameter" | Flags
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>number</code>
| Additional flags.
|}

Plugin:MirLua/Module/m hotkeys/en - Revision history

FuzzyBot: Updating to match new version of source page