User:Unsane/MirLua/m icolib: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
(Created page with "Предоставляет фукционал для работы с иконками. <br/> Подключение модуля: <code>local icolib = require('m_icolib')</cod...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Предоставляет фукционал для работы с иконками. <br/>
Предоставляет функциональность для работы с иконками. <br/>
Подключение модуля: <code>local icolib = require('m_icolib')</code>
Подключение модуля: <code>local icolib = require('m_icolib')</code>


Line 34: Line 34:
{{Content:MirLua/Example|code=
{{Content:MirLua/Example|code=
if icolib.GetIcon('iconUniqueName') then
if icolib.GetIcon('iconUniqueName') then
   print('Icon iconUniqueName is exists')
   print('Icon iconUniqueName exists')
end
end
}}
}}
Line 45: Line 45:
:: Тип: '''string'''
:: Тип: '''string'''
:: Уникальное название иконки
:: Уникальное название иконки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если иконка была удалена, иначе '''false'''
;Пример
;Пример
{{Content:MirLua/Example|code=icolib.RemoveIcon('iconUniqueName')}}
{{Content:MirLua/Example|code=icolib.RemoveIcon('iconUniqueName')}}

Latest revision as of 00:21, 6 November 2021

Предоставляет функциональность для работы с иконками.
Подключение модуля: local icolib = require('m_icolib')

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')