Plugin:MirLua/Module/m genmenu - Revision history

Dart Raiden: Marked this version for translation

2022-02-09T23:03:00Z

Marked this version for translation

Show changes

Goraf: make it translatable; (needs small translations from Russian)

2018-06-02T20:39:28Z

make it translatable; (needs small translations from Russian)

Show changes

Goraf: Goraf moved page Plugin:MirLua/en/m genmenu to Plugin:MirLua/Module/m genmenu: to transform to translation system

2018-06-02T19:13:47Z

Goraf moved page Plugin:MirLua/Module/m genmenu to Plugin:MirLua/Module/m genmenu: to transform to translation system

← Older revision	Revision as of 22:13, 2 June 2018
(No difference)

Unsane: disabled AddMenuItem

2016-01-04T17:37:23Z

disabled AddMenuItem

← Older revision		Revision as of 20:37, 4 January 2016
Line 8:		Line 8:

	__TOC__		__TOC__

	~~== Constants ==~~
	~~=== MO_MAIN ===~~
	~~Main menu.~~
	~~: Type: '''number'''~~

	~~=== MO_CONTACT ===~~
	~~Contact menu.~~
	~~: Type: '''number'''~~


	== Functions ==		== Functions ==
Line 41:		Line 31:
	{{Content:MirLua/Example\|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}		{{Content:MirLua/Example\|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}

			<!--
	=== AddMenuItem ===		=== AddMenuItem ===
	Creates menu item.		Creates menu item.
Line 57:		Line 48:
	local hMenuItem = genmenu.AddMenuItem(genmenu.MO_MAIN, { Name = 'MyMenuItem'})		local hMenuItem = genmenu.AddMenuItem(genmenu.MO_MAIN, { Name = 'MyMenuItem'})
	}}		}}
			-->

	=== ModifyMenuItem ===		=== ModifyMenuItem ===

Unsane at 18:17, 16 December 2015

2015-12-16T18:17:12Z

← Older revision		Revision as of 21:17, 16 December 2015
Line 140:		Line 140:
	: ''Service''		: ''Service''
	:: Type: '''string'''		:: Type: '''string'''
	:: [[Plugin:MirLua/en/m_core#CreateServiceFunction\|~~Function~~]] name.		:: [[Plugin:MirLua/en/m_core#CreateServiceFunction\|Service function]] name.
	: ''Position''		: ''Position''
	:: Type: '''number'''		:: Type: '''number'''

Unsane: Fixed link

2015-12-16T18:16:39Z

Fixed link

← Older revision		Revision as of 21:16, 16 December 2015
Line 69:		Line 69:
	: '''''icon'''''		: '''''icon'''''
	:: Type: '''light userdata'''		:: Type: '''light userdata'''
	:: [[Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle or ''[[Plugin:MirLua/en/~~m_icolib~~#INVALID_HANDLE_VALUE\|INVALID_HANDLE_VALUE]]''		:: [[Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE\|INVALID_HANDLE_VALUE]]''
	: '''''flags'''''		: '''''flags'''''
	:: Type: '''number'''		:: Type: '''number'''

RMN: wrong links syntax

2015-12-16T18:10:31Z

wrong links syntax

← Older revision		Revision as of 21:10, 16 December 2015
Line 34:		Line 34:
	: ''icon''		: ''icon''
	:: Type: '''light userdata'''		:: Type: '''light userdata'''
	:: [[#Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle.		:: [[Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle.
	;Result		;Result
	: Type: '''light userdata'''		: Type: '''light userdata'''
Line 69:		Line 69:
	: '''''icon'''''		: '''''icon'''''
	:: Type: '''light userdata'''		:: Type: '''light userdata'''
	:: [[#Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle or ''[[#Plugin:MirLua/en/m_icolib#INVALID_HANDLE_VALUE\|INVALID_HANDLE_VALUE]]''		:: [[Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle or ''[[Plugin:MirLua/en/m_icolib#INVALID_HANDLE_VALUE\|INVALID_HANDLE_VALUE]]''
	: '''''flags'''''		: '''''flags'''''
	:: Type: '''number'''		:: Type: '''number'''
Line 140:		Line 140:
	: ''Service''		: ''Service''
	:: Type: '''string'''		:: Type: '''string'''
	:: [[#Plugin:MirLua/en/m_core#CreateServiceFunction\|Function]] name.		:: [[Plugin:MirLua/en/m_core#CreateServiceFunction\|Function]] name.
	: ''Position''		: ''Position''
	:: Type: '''number'''		:: Type: '''number'''
Line 149:		Line 149:
	: ''Icon''		: ''Icon''
	:: Type: '''light userdata'''		:: Type: '''light userdata'''
	:: [[#Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle.		:: [[Plugin:MirLua/en/m_icolib#AddIcon\|Icon]] handle.
	: ''Flags''		: ''Flags''
	:: Type: '''number'''		:: Type: '''number'''

RMN: Plugin:MirLua/en/m_genmenu - needs revision

2015-12-16T17:58:36Z

Plugin:MirLua/en/m_genmenu - needs revision

New page

{{PageLang|en}}
Allows you to access menu subsystem.

Include module: <code>local genmenu = require('m_genmenu')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

== Constants ==
=== MO_MAIN ===
Main menu.
: Type: '''number'''

=== MO_CONTACT ===
Contact menu.
: Type: '''number'''

== Functions ==
=== CreateRoot ===
Creates root menu item.
;Parameters
: '''''hMenuObject'''''
:: Type: '''number'''
:: Global menu handle.
: '''''name'''''
:: Type: '''string'''
:: Menu item name.
: ''position''
:: Type: '''number'''
:: Menu item position.
: ''icon''
:: Type: '''light userdata'''
:: [[#Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle.
;Result
: Type: '''light userdata'''
: If success, returns menu item handle, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}

=== AddMenuItem ===
Creates menu item.
;Parameters
: '''''hMenuObject'''''
:: Type: '''number'''
:: Global menu handle.
: '''''menuItem'''''
:: Type: '''table'''
:: [[#MenuItem|MenuItem]] table.
;Result
: Type: '''light userdata'''
: If success, returns menu item handle, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=
local hMenuItem = genmenu.AddMenuItem(genmenu.MO_MAIN, { Name = 'MyMenuItem'})
}}

=== ModifyMenuItem ===
Modifies menu item.
;Parameters
: '''''hMenuItem'''''
:: Type: '''light userdata'''
:: Menu item handle.
: '''''name'''''
:: Type: '''string'''
:: New menu item name or '''nil'''.
: '''''icon'''''
:: Type: '''light userdata'''
:: [[#Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[#Plugin:MirLua/en/m_icolib#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''
: '''''flags'''''
:: Type: '''number'''
:: Additional flags or ''-1''
;Result
: Type: '''light userdata'''
: If success, returns menu item handle, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}

=== ShowMenuItem ===
Shows/hides menu item.
;Parameters
: '''''hMenuItem'''''
:: Type: '''light userdata'''
:: Menu item handle.
: '''''isShown'''''
:: Type: '''boolean'''
:: '''true''' to show menu item, '''false''' to hide it.
;Example
{{Content:MirLua/Example|code=genmenu.ShowMenuItem(hMenuItem, true)}}

=== EnableMenuItem ===
Enables/disables menu item.
;Parameters
: '''''hMenuItem'''''
:: Type: '''light userdata'''
:: Menu item handle.
: '''''isEnabled'''''
:: Type: '''boolean'''
:: '''true''' to enable menu item, '''false''' to disable it.
;Example
{{Content:MirLua/Example|code=genmenu.EnableMenuItem(hMenuItem, false)}}

=== CheckMenuItem ===
Checks/unchecks menu item.
;Parameters
: '''''hMenuItem'''''
:: Type: '''light userdata'''
:: Menu item handle.
: '''''isChecked'''''
:: Type: '''boolean'''
:: '''true''' to enable menu item, '''false''' to disable it.
;Example
{{Content:MirLua/Example|code=genmenu.CheckMenuItem(hMenuItem, true)}}

=== RemoveMenuItem ===
Removes menu item.
;Parameters
: '''''hMenuItem'''''
:: Type: '''light userdata'''
:: Menu item handle.
;Result
: Type: '''boolean'''
: If success, returns menu item handle, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=genmenu.RemoveMenuItem(hMenuItem)}}

== Structures ==
=== MenuItem ===
A table describing menu parameters.
;Fields
: '''''Name'''''
:: Type: '''string'''
:: Menu item name (automatically translated by Core).
: ''Uid''
:: Type: '''string'''
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.
: ''Service''
:: Type: '''string'''
:: [[#Plugin:MirLua/en/m_core#CreateServiceFunction|Function]] name.
: ''Position''
:: Type: '''number'''
:: Menu item position.
: ''Parent''
:: Type: '''light userdata'''
:: Parent menu handle.
: ''Icon''
:: Type: '''light userdata'''
:: [[#Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle.
: ''Flags''
:: Type: '''number'''
:: Additional flags.

[[Category:Tutorials (en)]]