Plugin:MirLua/Module/m hotkeys: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
m (Goraf moved page Plugin:MirLua/Module/m hotkeys to Plugin:MirLua/Module/m hotkeys: to transform to translation system)
(make it translatable)
Line 1: Line 1:
{{PageLang|en}}
<languages/>
<translate>
Allows you to work with key combinations.
Allows you to work with key combinations.
</translate>


Include module: <code>local hotkeys = require('m_hotkeys')</code>
{{Ls|MirLua/Modules/include_info}} <code>local hotkeys = require('m_hotkeys')</code>
 
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}
 


__TOC__
__TOC__


<translate>
== Functions ==
== Functions ==
</translate>
=== Register ===
=== Register ===
Registers a key combination.
<translate>Registers a key combination.</translate>
;Parameters
 
: '''''data'''''
==== {{Ls|MirLua/Modules/parameters}} ====
:: Type: '''table'''
{| class="wikitable"
:: [[#HotkeyItem|HotkeyItem]] table.
|-
;Result
! scope="col" | {{Ls|MirLua/Modules/param_name}}
: Type: '''boolean'''
! scope="col" | {{Ls|MirLua/Modules/required_param}}
: Returns '''true''' if key combination was registered successfully, otherwise '''false'''.
! scope="col" | {{Ls|Content/TableHeaders/type}}
;Example
! 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><tvar|HotkeyItem>[[#HotkeyItem|HotkeyItem]]</> table.</translate>
|}
 
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
 
{{nbsp|5}}<translate>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>Removes a key combination.</translate>
;Parameters
 
: '''''name'''''
==== {{Ls|MirLua/Modules/parameters}} ====
:: Type: '''string'''
{| class="wikitable"
:: Key combination name.
|-
;Result
! scope="col" | {{Ls|MirLua/Modules/param_name}}
: Type: '''boolean'''
! scope="col" | {{Ls|MirLua/Modules/required_param}}
: Returns '''true''' if key combination was removed successfully, otherwise '''false'''.
! scope="col" | {{Ls|Content/TableHeaders/type}}
;Example
! 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>Key combination name.</translate>
|}
 
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
 
{{nbsp|5}}<translate>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>Creates key combination.</translate>
;Parameters
 
: '''''modifier'''''
==== {{Ls|MirLua/Modules/parameters}} ====
:: Type: '''number'''
{| class="wikitable"
:: Modifier key codes:
|-
::: shift = 0x01
! scope="col" | {{Ls|MirLua/Modules/param_name}}
::: control = 0x02
! scope="col" | {{Ls|MirLua/Modules/required_param}}
::: alt = 0x04
! scope="col" | {{Ls|Content/TableHeaders/type}}
::: win = 0x08
! scope="col" | {{Ls|Content/TableHeaders/description}}
: '''''key'''''
|-
:: Type: '''string'''
! scope="row" class="MirLuaParametersTable-parameter" | modifier
:: Normal (non-modifier) key.
| style="text-align:center" | {{Ls|YesNo/yes}}
;Result
| style="text-align:center" | <code>number</code>, <code>string</code>, <code>table</code>
: Type: '''number'''
| <translate>Modifier key code or name or list of names. Takes values:</translate>
: Returns key combination.
* shift = 0x01
;Example
* 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>Normal (non-modifier) key.</translate>
|}
 
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>
 
{{nbsp|5}}<translate>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 106:
}}
}}


{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey('ctrl', 'A')
}}


{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')
}}
<translate>
== Structures ==
== Structures ==
</translate>
=== HotkeyItem ===
=== HotkeyItem ===
A table describing key combination parameters.
<translate>A table describing key combination parameters.</translate>
;Fields
 
==== {{Ls|MirLua/Modules/fields}} ====
: '''''Name'''''
: '''''Name'''''
:: Type: '''string'''
:: Type: '''string'''
Line 84: Line 140:
:: Type: '''number'''
:: Type: '''number'''
:: Additional flags.
:: Additional flags.
[[Category:Tutorials (en)]]

Revision as of 18:46, 2 June 2018

Other languages:

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:
  • shift = 0x01
  • control = 0x02
  • alt = 0x04
  • win = 0x08
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

Name
Type: string
Name of key combination (automatically translated by Core).
Description
Type: string
Description of key combination (automatically translated by Core).
Section
Type: string
Section name in Miranda hotkey settings. By default plugin name (MirLua) is used.
Hotkey
Type: number
Default key combination.
Service
Type: string
Service name.
Flags
Type: number
Additional flags.
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_hotkeys&oldid=30516"