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

From Miranda NG
Jump to navigation Jump to search
(make it translatable; (needs small translations from Russian))
(Marked this version for translation)
 
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>
<!--T:1-->
Allows you to access menu subsystem.
Allows you to access menu subsystem.
</translate>
</translate>
Line 9: Line 10:


<translate>
<translate>
== Functions ==
== Functions == <!--T:2-->
</translate>
</translate>


=== ModifyMenuItem ===
=== ModifyMenuItem ===
<translate>Modifies menu item.</translate>
<translate><!--T:3--> Modifies menu item.</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>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>Menu item handle.</translate>
| <translate><!--T:4--> Menu item handle.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>New menu item name or <tvar|nil><code>nil</code></>.</translate>
| <translate><!--T:5--> New menu item name or <tvar|nil><code>nil</code></>.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | icon
! scope="row" class="MirLuaParametersTable-parameter" | icon
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>[[<tvar|link>Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon</>|Icon handle]] or <tvar|INVALID_HANDLE_VALUE><code>[[Special:MyLanguage/Plugin:MirLua/Module/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]</code></>.</translate>
| <translate><!--T:6--> [[<tvar|link>Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon</>|Icon handle]] or <tvar|INVALID_HANDLE_VALUE><code>[[Special:MyLanguage/Plugin:MirLua/Module/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]</code></>.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | flags
! scope="row" class="MirLuaParametersTable-parameter" | flags
| 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>Additional flags or <tvar|value_-1><code>-1</code></>.</translate>
| <translate><!--T:7--> Additional flags or <tvar|value_-1><code>-1</code></>.</translate>
|}
|}


Line 47: Line 48:
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>


{{nbsp|5}}<translate>Returns <tvar|true><code>true</code></> on success, otherwise <tvar|false><code>false</code></>.</translate>
{{nbsp|5}}<translate><!--T:8--> Returns <tvar|true><code>true</code></> on success, otherwise <tvar|false><code>false</code></>.</translate>


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/example}} ====
Line 67: Line 68:
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>Menu item handle.</translate>
| <translate><!--T:9--> Menu item handle.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | option
! scope="row" class="MirLuaParametersTable-parameter" | option
Line 77: Line 78:
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>Value of the option.</translate>
| <translate><!--T:10--> Value of the option.</translate>
|}
|}


Line 93: Line 94:
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code>
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code>


{{nbsp|5}}<translate>Returns <tvar|true><code>true</code></> on success, otherwise <tvar|false><code>false</code></>.</translate>
{{nbsp|5}}<translate><!--T:11--> Returns <tvar|true><code>true</code></> on success, otherwise <tvar|false><code>false</code></>.</translate>
----
----


=== ShowMenuItem ===
=== ShowMenuItem ===
<translate>Shows/hides menu item.</translate>
<translate><!--T:12--> Shows/hides menu item.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
Line 110: Line 111:
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>Menu item handle.</translate>
| <translate><!--T:13--> Menu item handle.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | isShown
! scope="row" class="MirLuaParametersTable-parameter" | isShown
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>boolean</code>
| style="text-align:center" | <code>boolean</code>
| <translate>Pass <tvar|true><code>true</code></> to show menu item, <tvar|false><code>false</code></> to hide it.</translate>
| <translate><!--T:14--> Pass <tvar|true><code>true</code></> to show menu item, <tvar|false><code>false</code></> to hide it.</translate>
|}
|}


Line 123: Line 124:


=== EnableMenuItem ===
=== EnableMenuItem ===
<translate>Enables/disables menu item.</translate>
<translate><!--T:15--> Enables/disables menu item.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
Line 136: Line 137:
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>Menu item handle.</translate>
| <translate><!--T:16--> Menu item handle.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | isEnabled
! scope="row" class="MirLuaParametersTable-parameter" | isEnabled
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>boolean</code>
| style="text-align:center" | <code>boolean</code>
| <translate>Pass <tvar|true><code>true</code></> to enable menu item, <tvar|false><code>false</code></> to disable it.</translate>
| <translate><!--T:17--> Pass <tvar|true><code>true</code></> to enable menu item, <tvar|false><code>false</code></> to disable it.</translate>
|}
|}


Line 149: Line 150:


=== CheckMenuItem ===
=== CheckMenuItem ===
<translate>Checks/unchecks menu item.</translate>
<translate><!--T:18--> Checks/unchecks menu item.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
Line 162: Line 163:
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>Menu item handle.</translate>
| <translate><!--T:19--> Menu item handle.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | isChecked
! scope="row" class="MirLuaParametersTable-parameter" | isChecked
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>boolean</code>
| style="text-align:center" | <code>boolean</code>
| <translate>Pass <tvar|true><code>true</code></> to check menu item, <tvar|false><code>false</code></> to uncheck it.</translate>
| <translate><!--T:20--> Pass <tvar|true><code>true</code></> to check menu item, <tvar|false><code>false</code></> to uncheck it.</translate>
|}
|}


Line 175: Line 176:


=== RemoveMenuItem ===
=== RemoveMenuItem ===
<translate>Removes menu item.</translate>
<translate><!--T:21--> Removes menu item.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
Line 188: Line 189:
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| style="text-align:center" | <code>light userdata</code>
| <translate>Menu item handle.</translate>
| <translate><!--T:22--> Menu item handle.</translate>
|}
|}


Line 194: Line 195:
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>


{{nbsp|5}}<translate>Returns <tvar|true><code>true</code></> on success, otherwise <tvar|false><code>false</code></>.</translate>
{{nbsp|5}}<translate><!--T:23--> Returns <tvar|true><code>true</code></> on success, otherwise <tvar|false><code>false</code></>.</translate>


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/example}} ====
Line 200: Line 201:


<translate>
<translate>
== Structures ==
== Structures == <!--T:24-->
</translate>
</translate>


=== MenuItem ===
=== MenuItem ===
<translate>A table describing menu parameters.</translate>
<translate><!--T:25--> A table describing menu parameters.</translate>


==== {{Ls|MirLua/Modules/fields}} ====
==== {{Ls|MirLua/Modules/fields}} ====
Line 217: Line 218:
| 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 (automatically translated by Core).</translate>
| <translate><!--T:26--> Menu item name (automatically translated by Core).</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | Uid
! scope="row" class="MirLuaParametersTable-parameter" | Uid
| 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>Plugin UUID in format <tvar|uuid_format>''<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>''</>.</translate>
| <translate><!--T:27--> Plugin UUID in format <tvar|uuid_format>''<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>''</>.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | Service
! scope="row" class="MirLuaParametersTable-parameter" | Service
| 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>
| [[Special:MyLanguage/Plugin:MirLua/Module/m_core#CreateServiceFunction|<translate>Service name.</translate>]]
| [[Special:MyLanguage/Plugin:MirLua/Module/m_core#CreateServiceFunction|<translate><!--T:28--> Service 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:29--> Menu item position.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | Parent
! scope="row" class="MirLuaParametersTable-parameter" | Parent
| 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>
| <translate>Parent menu handle.</translate>
| <translate><!--T:30--> Parent menu handle.</translate>
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | Icon
! scope="row" class="MirLuaParametersTable-parameter" | Icon
| 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:31--> Icon handle.</translate>]]
|-
|-
! scope="row" class="MirLuaParametersTable-parameter" | Flags
! scope="row" class="MirLuaParametersTable-parameter" | Flags
| 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>Additional flags.</translate>
| <translate><!--T:32--> Additional flags.</translate>
|}
|}

Latest revision as of 02:03, 10 February 2022

Other languages:
  • English

Allows you to access menu subsystem.

Include module: local genmenu = require('m_genmenu')

Functions

ModifyMenuItem

Modifies menu item.

Parameters

Parameter name Required Type Description
hMenuItem Yes light userdata Menu item handle.
name Yes light userdata New menu item name or nil.
icon Yes light userdata Icon handle or INVALID_HANDLE_VALUE.
flags No number Additional flags or -1.

Result

     Type: boolean

     Returns true on success, otherwise false.

Example

local hMenuItem = genmenu.ModifyMenuItem(hMenuItem, 'New name', m.INVALID_HANDLE_VALUE)

ConfigureMenuItem

Дополнительная настройка пункта меню.

Parameters

Parameter name Required Type Description
hMenuItem Yes light userdata Menu item handle.
option Yes number
value Yes light userdata Value of the option.
hMenuItem
Тип: light userdata
Дескриптор пункта меню.
option
Тип: 'number'
изменяемая настройка (1 - название; 2 - горячие клавиши; 3 - параметр для исполнения; 4 - UUID).
value
Тип: light userdata
значение.

Result

     Type: light userdata

     Returns true on success, otherwise false.


ShowMenuItem

Shows/hides menu item.

Parameters

Parameter name Required Type Description
hMenuItem Yes light userdata Menu item handle.
isShown Yes boolean Pass true to show menu item, false to hide it.

Example

genmenu.ShowMenuItem(hMenuItem, true)

EnableMenuItem

Enables/disables menu item.

Parameters

Parameter name Required Type Description
hMenuItem Yes light userdata Menu item handle.
isEnabled Yes boolean Pass true to enable menu item, false to disable it.

Example

genmenu.EnableMenuItem(hMenuItem, false)

CheckMenuItem

Checks/unchecks menu item.

Parameters

Parameter name Required Type Description
hMenuItem Yes light userdata Menu item handle.
isChecked Yes boolean Pass true to check menu item, false to uncheck it.

Example

genmenu.CheckMenuItem(hMenuItem, true)

RemoveMenuItem

Removes menu item.

Parameters

Parameter name Required Type Description
hMenuItem Yes light userdata Menu item handle.

Result

     Type: boolean

     Returns true on success, otherwise false.

Example

genmenu.RemoveMenuItem(hMenuItem)

Structures

MenuItem

A table describing menu parameters.

Fields

Field name Required Type Description
Name Yes string Menu item name (automatically translated by Core).
Uid No string Plugin UUID in format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
Service No string Service name.
Position No number Menu item position.
Parent No light userdata Parent menu handle.
Icon No light userdata Icon handle.
Flags No number Additional flags.