Plugin:MirLua/ru/m icolib: Difference between revisions

From Miranda NG
< MirLua‎ | MirLua
Jump to navigation Jump to search
(Plugin:MirLua/ru/m_icolib - from User:Unsane/MirLua/m_icolib)
 
(+TOC)
Line 6: Line 6:
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}


__TOC__


=== AddIcon ===
=== AddIcon ===

Revision as of 22:35, 16 December 2015

Предоставляет функционал для работы со значками.

Подключение модуля: local icolib = require('m_icolib')

<translate> Note</translate>
Параметры, выделенные жирным курсивом, являются обязательными.


AddIcon

Регистрирует значок.

Параметры
name
Тип: string
Уникальное название значка.
description
Тип: string
Описание.
section
Тип: string
Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (MirLua).
Результат
Тип: light userdata
Возвращает дескриптор значка, если значок был успешно зарегистрирован, иначе nil.
Пример
local hIcon = icolib.AddIcon('iconUniqueName', 'My super icon')


GetIcon

Возвращает дескриптор значка.

Параметры
name
Тип: string
Уникальное название значка.
Результат
Тип: boolean
Возвращает дескриптор значка, если значок был найден, иначе nil.
Пример
if icolib.GetIcon('iconUniqueName') then
  print('Icon iconUniqueName exists')
end


RemoveIcon

Удаляет значок.

Параметры
name
Тип: string
Уникальное название значка.
Пример
icolib.RemoveIcon('iconUniqueName')