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

From Miranda NG
< MirLua‎ | MirLua
Jump to navigation Jump to search
(+TOC)
mNo edit summary
Line 20: Line 20:
: ''section''
: ''section''
:: Тип: '''string'''
:: Тип: '''string'''
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (MirLua).
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (''MirLua'').
: ''path''
:: Тип: '''string'''
:: Файл, из которого будет загружен значок. По умолчанию путь к исполняемому файлу Miranda NG.
;Результат
;Результат
: Тип: '''light userdata'''
: Тип: '''light userdata'''

Revision as of 00:36, 26 December 2015

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

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

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


AddIcon

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

Параметры
name
Тип: string
Уникальное название значка.
description
Тип: string
Описание.
section
Тип: string
Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (MirLua).
path
Тип: string
Файл, из которого будет загружен значок. По умолчанию путь к исполняемому файлу Miranda NG.
Результат
Тип: 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')