24. 脚本 API 引用 | 菜单

模块: Menu

studio.menu 模块提供对菜单栏项的访问。

menu.addMenuItem（说明）

根据描述对象在“脚本”菜单下注册一个菜单项:

{
    name: [string] (required),
    execute: [function] (required),
    keySequence: [string],
    isEnabled: [bool] (dynamic),
    isChecked: [bool] (dynamic),
    subMenuItems: [array(description)] (dynamic),
}

名称属性必须是字符串，但其他属性可以指定要动态调用的函数，即可返回预期类型值的函数（例如，可能要根据所选内容重新评估 isEnabled ）。在项目名称中使用“\”字符会将其置于子菜单中。添加名称包含所有破折号（'-' 字符）的项目将导致添加分隔符。

• name: 出现在菜单中的菜单项的名称。
• execute: 菜单项要调用的函数。
  -keySequence: 菜单项的键盘快捷键。
  -isEnabled: 确定菜单项何时启用。
  -isChecked: 确定菜单项旁边是否出现复选标记。
  -subMenuItems: 指定出现在菜单项的关联子菜单中的项目（如果有）。

如果操作成功，则返回 true ，否则返回 false 。

menu.removeMenuItem（描述）

删除使用menu.addMenuItem()添加的菜单项。description 参数必须与添加菜单项的 description 相匹配。

如果操作成功，则返回 true ，否则返回 false 。

菜单.menuItems()

返回添加了menu.addMenuItem()的菜单项描述的Array 。Array 的顺序与添加项目的顺序相匹配。