Plugin:MirLua/Module/m clist: Difference between revisions
Jump to navigation
Jump to search
(make it translatable (needs proofreading)) |
Dart Raiden (talk | contribs) (Marked this version for translation) |
||
| Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
<translate> | <translate> | ||
<!--T:1--> | |||
Allows you to work with menus of the contact list. | Allows you to work with menus of the contact list. | ||
</translate> | </translate> | ||
| Line 9: | Line 10: | ||
<translate> | <translate> | ||
== Main menu == | == Main menu == <!--T:2--> | ||
</translate> | </translate> | ||
=== AddMainMenuRoot === | === AddMainMenuRoot === | ||
<translate>Creates a root menu item in the main menu.</translate> | <translate><!--T:3--> Creates a root menu item in the main menu.</translate> | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
| Line 26: | Line 27: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| <translate>Menu item name.</translate> | | <translate><!--T:4--> Menu item name.</translate> | ||
|- | |- | ||
! scope="row" class="MirLuaParametersTable-parameter" | position | ! scope="row" class="MirLuaParametersTable-parameter" | position | ||
| style="text-align:center" | {{Ls|YesNo/no}} | | style="text-align:center" | {{Ls|YesNo/no}} | ||
| style="text-align:center" | <code>number</code> | | style="text-align:center" | <code>number</code> | ||
| <translate>Menu item position.</translate> | | <translate><!--T:5--> Menu item position.</translate> | ||
|- | |- | ||
! scope="row" class="MirLuaParametersTable-parameter" | hIcon | ! scope="row" class="MirLuaParametersTable-parameter" | hIcon | ||
| style="text-align:center" | {{Ls|YesNo/no}} | | style="text-align:center" | {{Ls|YesNo/no}} | ||
| style="text-align:center" | <code>light userdata</code> | | style="text-align:center" | <code>light userdata</code> | ||
| [[Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon|<translate>Icon handle.</translate>]] | | [[Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon|<translate><!--T:6--> Icon handle.</translate>]] | ||
|} | |} | ||
| Line 42: | Line 43: | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate>If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:7--> If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
| Line 49: | Line 50: | ||
=== AddMainMenuItem === | === AddMainMenuItem === | ||
<translate>Creates a menu item in the main menu.</translate> | <translate><!--T:8--> Creates a menu item in the main menu.</translate> | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
| Line 62: | Line 63: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>table</code> | | style="text-align:center" | <code>table</code> | ||
| <translate><tvar|MenuItem>[[Special:MyLanguage/Plugin:MirLua/Module/m_genmenu#MenuItem|MenuItem]]</> table.</translate> | | <translate><!--T:9--> <tvar|MenuItem>[[Special:MyLanguage/Plugin:MirLua/Module/m_genmenu#MenuItem|MenuItem]]</> table.</translate> | ||
|} | |} | ||
| Line 68: | Line 69: | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate>If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:10--> If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
| Line 74: | Line 75: | ||
<translate> | <translate> | ||
== Contact menu == | == Contact menu == <!--T:11--> | ||
</translate> | </translate> | ||
=== AddContactMenuRoot === | === AddContactMenuRoot === | ||
<translate>Creates a root menu item in the contact menu.</translate> | <translate><!--T:12--> Creates a root menu item in the contact menu.</translate> | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
| Line 91: | Line 92: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| <translate>Menu item name.</translate> | | <translate><!--T:13--> Menu item name.</translate> | ||
|- | |- | ||
! scope="row" class="MirLuaParametersTable-parameter" | position | ! scope="row" class="MirLuaParametersTable-parameter" | position | ||
| style="text-align:center" | {{Ls|YesNo/no}} | | style="text-align:center" | {{Ls|YesNo/no}} | ||
| style="text-align:center" | <code>number</code> | | style="text-align:center" | <code>number</code> | ||
| <translate>Menu item position.</translate> | | <translate><!--T:14--> Menu item position.</translate> | ||
|- | |- | ||
! scope="row" class="MirLuaParametersTable-parameter" | hIcon | ! scope="row" class="MirLuaParametersTable-parameter" | hIcon | ||
| style="text-align:center" | {{Ls|YesNo/no}} | | style="text-align:center" | {{Ls|YesNo/no}} | ||
| style="text-align:center" | <code>light userdata</code> | | style="text-align:center" | <code>light userdata</code> | ||
| [[Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon|<translate>Icon handle.</translate>]] | | [[Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon|<translate><!--T:15--> Icon handle.</translate>]] | ||
|} | |} | ||
| Line 107: | Line 108: | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate>If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:16--> If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
| Line 114: | Line 115: | ||
=== AddContactMenuItem === | === AddContactMenuItem === | ||
<translate>Creates a menu item in the contact menu.</translate> | <translate><!--T:17--> Creates a menu item in the contact menu.</translate> | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
| Line 127: | Line 128: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>table</code> | | style="text-align:center" | <code>table</code> | ||
| <translate><tvar|MenuItem>[[Special:MyLanguage/Plugin:MirLua/Module/m_genmenu#MenuItem|MenuItem]]</> table.</translate> | | <translate><!--T:18--> <tvar|MenuItem>[[Special:MyLanguage/Plugin:MirLua/Module/m_genmenu#MenuItem|MenuItem]]</> table.</translate> | ||
|- | |- | ||
! scope="row" class="MirLuaParametersTable-parameter" | protocol | ! scope="row" class="MirLuaParametersTable-parameter" | protocol | ||
| style="text-align:center" | {{Ls|YesNo/no}} | | style="text-align:center" | {{Ls|YesNo/no}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| <translate>Name of the protocol (prefix for the service name)</translate> | | <translate><!--T:19--> Name of the protocol (prefix for the service name)</translate> | ||
|} | |} | ||
| Line 138: | Line 139: | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate>If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:20--> If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
| Line 144: | Line 145: | ||
<translate> | <translate> | ||
== Tray menu == | == Tray menu == <!--T:21--> | ||
</translate> | </translate> | ||
=== AddTrayMenuItem === | === AddTrayMenuItem === | ||
<translate>Creates a menu item in the tray menu.</translate> | <translate><!--T:22--> Creates a menu item in the tray menu.</translate> | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
| Line 161: | Line 162: | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>table</code> | | style="text-align:center" | <code>table</code> | ||
| <translate><tvar|MenuItem>[[Special:MyLanguage/Plugin:MirLua/Module/m_genmenu#MenuItem|MenuItem]]</> table.</translate> | | <translate><!--T:23--> <tvar|MenuItem>[[Special:MyLanguage/Plugin:MirLua/Module/m_genmenu#MenuItem|MenuItem]]</> table.</translate> | ||
|} | |} | ||
| Line 167: | Line 168: | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | {{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code> | ||
{{nbsp|5}}<translate>If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | {{nbsp|5}}<translate><!--T:24--> If success, returns menu item handle, otherwise <tvar|nil><code>nil</code></>.</translate> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
{{Content:MirLua/Example|code=local hMenuItem = m.AddTrayMenuItem ({ Name ='My menu item' })}} | {{Content:MirLua/Example|code=local hMenuItem = m.AddTrayMenuItem ({ Name ='My menu item' })}} | ||
Latest revision as of 02:02, 10 February 2022
Allows you to work with menus of the contact list.
Include module: local clist = require('m_clist')
AddMainMenuRoot
Creates a root menu item in the main menu.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Menu item name. |
| position | No | number
|
Menu item position. |
| hIcon | No | light userdata
|
Icon handle. |
Result
Type: light userdata
If success, returns menu item handle, otherwise nil.
Example
local hRootMenuItem = m.AddMainMenuRoot('My root menu item')AddMainMenuItem
Creates a menu item in the main menu.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| data | Yes | table
|
MenuItem table. |
Result
Type: light userdata
If success, returns menu item handle, otherwise nil.
Example
local hMenuItem = m.AddMainMenuItem({ Name ='My menu item' })AddContactMenuRoot
Creates a root menu item in the contact menu.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Menu item name. |
| position | No | number
|
Menu item position. |
| hIcon | No | light userdata
|
Icon handle. |
Result
Type: light userdata
If success, returns menu item handle, otherwise nil.
Example
local hRootMenuItem = m.AddContactMenuRoot('My contact menu item')AddContactMenuItem
Creates a menu item in the contact menu.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| data | Yes | table
|
MenuItem table. |
| protocol | No | string
|
Name of the protocol (prefix for the service name) |
Result
Type: light userdata
If success, returns menu item handle, otherwise nil.
Example
local hMenuItem = m.AddContactMenuItem ({ Name ='My menu item' })AddTrayMenuItem
Creates a menu item in the tray menu.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| data | Yes | table
|
MenuItem table. |
Result
Type: light userdata
If success, returns menu item handle, otherwise nil.
Example
local hMenuItem = m.AddTrayMenuItem ({ Name ='My menu item' })