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

From Miranda NG
< MirLua‎ | MirLua
Jump to navigation Jump to search
(links fixed)
mNo edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 8: Line 8:


__TOC__
__TOC__
== Константы ==
=== MO_MAIN ===
Главное меню
: Тип: '''number'''
=== MO_CONTACT ===
Меню контакта
: Тип: '''number'''


== Функции ==
== Функции ==
<!--
=== CreateRoot ===
=== CreateRoot ===
Создает корневой пункт меню
Создает корневой пункт меню
Line 28: Line 19:
: '''''name'''''
: '''''name'''''
:: Тип: '''string'''
:: Тип: '''string'''
:: Имя пункта меню
:: Название пункта меню
: ''position''
: ''position''
:: Тип: '''number'''
:: Тип: '''number'''
Line 36: Line 27:
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]
;Результат
;Результат
: Тип: '''light userdata'''
: Тип: '''boolean'''
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''
: Возвращает '''true''' случае успеха, иначе '''false'''
;Пример
;Пример
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}
Line 57: Line 48:
local hMenuItem = genmenu.AddMenuItem(genmenu.MO_MAIN, { Name = 'MyMenuItem'})
local hMenuItem = genmenu.AddMenuItem(genmenu.MO_MAIN, { Name = 'MyMenuItem'})
}}
}}
-->


=== ModifyMenuItem ===
=== ModifyMenuItem ===
Line 66: Line 58:
: '''''name'''''
: '''''name'''''
:: Тип: '''string'''
:: Тип: '''string'''
:: Новое имя меню или '''nil'''
:: Новое название пункта меню или '''nil'''
: '''''icon'''''
: '''''icon'''''
:: Тип: '''light userdata'''
:: Тип: '''light userdata'''
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]] или ''[[Plugin:MirLua/ru/m_icolib#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]] или ''[[Plugin:MirLua/ru/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''
: '''''flags'''''
: '''''flags'''''
:: Тип: '''number'''
:: Тип: '''number'''
:: Дополнительные флаги или ''-1''
:: Дополнительные флаги или ''-1''
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=local hMenuItem = genmenu.ModifyMenuItem(hMenuItem, 'New name', m.INVALID_HANDLE_VALUE)}}
=== ConfigureMenuItem ===
Дополнительная настройка пункта меню
;Параметры
: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню
: '''''option'''''
:: Тип: ''''''number''''''
:: изменяемая настройка (1 - название; 2 - горячие клавиши; 3 - параметр для исполнения; 4 - UUID)
: '''''value'''''
:: Тип: '''light userdata'''
:: значение
;Результат
;Результат
: Тип: '''light userdata'''
: Тип: '''light userdata'''
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''
: Возвращает '''true''' случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}


=== ShowMenuItem ===
=== ShowMenuItem ===
Line 134: Line 143:
: '''''Name'''''
: '''''Name'''''
:: Тип: '''string'''
:: Тип: '''string'''
:: Имя пункта меню (автоматически переводится ядром)
:: Название пункта меню (автоматически переводится ядром)
: ''Uid''
: ''Uid''
:: Тип: '''string'''
:: Тип: '''string'''

Latest revision as of 20:26, 2 September 2017

Предоставляет доступ к подсистеме меню.

Подключение модуля: local genmenu = require('m_genmenu')

<translate> Note</translate>
Параметры, выделенные жирным курсивом, являются обязательными.


Функции

ModifyMenuItem

Изменяет пункт меню

Параметры
hMenuItem
Тип: light userdata
Дескриптор пункта меню
name
Тип: string
Новое название пункта меню или nil
icon
Тип: light userdata
Дескриптор значка или INVALID_HANDLE_VALUE
flags
Тип: number
Дополнительные флаги или -1
Результат
Тип: boolean
Возвращает true случае успеха, иначе false
Пример
local hMenuItem = genmenu.ModifyMenuItem(hMenuItem, 'New name', m.INVALID_HANDLE_VALUE)


ConfigureMenuItem

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

Параметры
hMenuItem
Тип: light userdata
Дескриптор пункта меню
option
Тип: 'number'
изменяемая настройка (1 - название; 2 - горячие клавиши; 3 - параметр для исполнения; 4 - UUID)
value
Тип: light userdata
значение
Результат
Тип: light userdata
Возвращает true случае успеха, иначе false

ShowMenuItem

Показывает/скрывает пункт меню

Параметры
hMenuItem
Тип: light userdata
Дескриптор пункта меню
isShown
Тип: boolean
true для отображения пункта меню, false для скрытия
Пример
genmenu.ShowMenuItem(hMenuItem, true)

EnableMenuItem

Включает/отключает пункт меню

Параметры
hMenuItem
Тип: light userdata
Дескриптор пункта меню
isEnabled
Тип: boolean
true для включения пункта меню, false для отключения
Пример
genmenu.EnableMenuItem(hMenuItem, false)

CheckMenuItem

Отмечает/снимает отметку с пункта меню

Параметры
hMenuItem
Тип: light userdata
Дескриптор пункта меню
isChecked
Тип: boolean
true для включения пункта меню, false для отключения
Пример
genmenu.CheckMenuItem(hMenuItem, true)

RemoveMenuItem

Удаляет пункт меню

Параметры
hMenuItem
Тип: light userdata
Дескриптор пункта меню
Результат
Тип: boolean
Возвращает true случае успеха, иначе false
Пример
genmenu.RemoveMenuItem(hMenuItem)


Структуры

MenuItem

Таблица, описывающая параметры меню

Поля
Name
Тип: string
Название пункта меню (автоматически переводится ядром)
Uid
Тип: string
UUID пункта меню в формате xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Service
Тип: string
Имя сервиса
Position
Тип: number
Позиция пункта меню
Parent
Тип: light userdata
Дескриптор родительского меню
Icon
Тип: light userdata
Дескриптор значка
Flags
Тип: number
Дополнительные флаги
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_genmenu&oldid=19870"