Plugin:MirLua/Module/m hotkeys

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.