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

From Miranda NG
Jump to navigation Jump to search
m (Goraf moved page Plugin:MirLua/Module/m icolib to Plugin:MirLua/Module/m icolib: to transform to translation system)
(make it translatable)
Line 1: Line 1:
{{PageLang|en}}
<translate>
Allows you to work with icons.
Allows you to work with icons.
</translate>


Include module: <code>local icolib = require('m_icolib')</code>
{{Ls|MirLua/Modules/include_info}} <code>local icolib = require('m_icolib')</code>


{{Note|Parameters written in '''''bold italics''''' are obligatory.}}
__TOC__
 
=== AddIcon ===
<translate>Registers an icon.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| <translate>Unique icon name.</translate>
|-
! scope="row" class="MirLuaParametersTable-parameter" | description
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| <translate>Description.</translate>
|-
! scope="row" class="MirLuaParametersTable-parameter" | section
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| <translate>Section name in Miranda icon settings. By default plugin name (<tvar|MirLua>MirLua</>) is used.</translate>
|-
! scope="row" class="MirLuaParametersTable-parameter" | path
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| <translate>Default icon file to use. By default path to executable file of Miranda NG is used.</translate>
|}


__TOC__
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code>
 
{{nbsp|5}}<translate>Returns icon handle if icon was registered successfully, otherwise <tvar|nil><code>nil</code></>.</translate>


=== AddIcon ===
==== {{Ls|MirLua/Modules/example}} ====
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
{{Content:MirLua/Example|code=local hIcon = icolib.AddIcon('iconUniqueName', 'My super icon')}}
{{Content:MirLua/Example|code=local hIcon = icolib.AddIcon('iconUniqueName', 'My super icon')}}
----
=== GetIcon ===
<translate>Returns icon handle.</translate>
==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| <translate>Unique icon name.</translate>
|}


==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
{{nbsp|5}}<translate>Returns icon handle if icon was found, otherwise <tvar|nil><code>nil</code></>.</translate>


=== GetIcon ===
==== {{Ls|MirLua/Modules/example}} ====
Returns icon handle.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique icon name.
;Result
: Type: '''boolean'''
: Returns icon handle if icon was found, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=
{{Content:MirLua/Example|code=
if icolib.GetIcon('iconUniqueName') then
if icolib.GetIcon('iconUniqueName') then
Line 46: Line 75:
end
end
}}
}}
----


=== RemoveIcon ===
<translate>Removes an icon.</translate>


=== RemoveIcon ===
==== {{Ls|MirLua/Modules/parameters}} ====
Removes an icon.
{| class="wikitable"
;Parameters
|-
: '''''name'''''
! scope="col" | {{Ls|MirLua/Modules/param_name}}
:: Type: '''string'''
! scope="col" | {{Ls|MirLua/Modules/required_param}}
:: Unique icon name.
! scope="col" | {{Ls|Content/TableHeaders/type}}
;Example
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| <translate>Unique icon name.</translate>
|}
 
==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=icolib.RemoveIcon('iconUniqueName')}}
{{Content:MirLua/Example|code=icolib.RemoveIcon('iconUniqueName')}}
[[Category:Tutorials (en)]]

Revision as of 18:03, 2 June 2018

Allows you to work with icons.

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

AddIcon

Registers an icon.

Parameters

Parameter name Required Type Description
name Yes string Unique icon name.
description Yes string Description.
section No string Section name in Miranda icon settings. By default plugin name (MirLua) is used.
path No 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

Parameter name Required Type Description
name Yes 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

Parameter name Required Type Description
name Yes string Unique icon name.

Example

icolib.RemoveIcon('iconUniqueName')
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_icolib&oldid=30509"