Plugin:MirLua/Module/m icolib

Allows you to work with icons.

Include module: local icolib = require('m_icolib')

<translate> Note</translate>
Parameters written in bold italics are obligatory.

AddIcon

Registers an icon.

Parameters

name

Type: string

Unique icon name.

description

Type: string

Description.

section

Type: string

Section name in Miranda icon settings. By default plugin name (MirLua) is used.

path

Type: string

Default icon file to use. By default path to executable file of Miranda NG is used.

Result

Type: light userdata

Returns icon handle if icon was registered successfully, otherwise nil.

Example

local hIcon = icolib.AddIcon('iconUniqueName', 'My super icon')

GetIcon

Returns icon handle.

Parameters

name

Type: string

Unique icon name.

Result

Type: boolean

Returns icon handle if icon was found, otherwise nil.

Example

if icolib.GetIcon('iconUniqueName') then
  print('Icon iconUniqueName exists')
end

RemoveIcon

Removes an icon.

Parameters

name

Type: string

Unique icon name.

Example

icolib.RemoveIcon('iconUniqueName')