Plugin:MirLua/ru/m genmenu

From Miranda NG
Jump to: navigation, search

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

Подключение модуля: 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
Дополнительные флаги