docs » plugins.core.menu.manager


Menu Manager Plugin.

Submodules

API Overview

API Documentation

Functions

addSection

Signature plugins.core.menu.manager.addSection(priority) -> section
Type Function
Description Creates a new menu section, which can have items and sub-menus added to it.
Parameters
  • priority - The priority order of menu items created in the section relative to other sections.
Returns
  • section - The section that was created.

addTitleSuffix

Signature plugins.core.menu.manager.addTitleSuffix(fnTitleSuffix)
Type Function
Description Allows you to add a custom Suffix to the Menubar Title
Parameters
  • fnTitleSuffix - A function that returns a single string
Returns
  • None

disable

Signature plugins.core.menu.manager.disable(priority) -> menubaritem
Type Function
Description Removes the menu from the system menu bar.
Parameters
  • None
Returns
  • the menubaritem

enable

Signature plugins.core.menu.manager.enable(priority) -> menubaritem
Type Function
Description Returns the previously removed menu back to the system menu bar.
Parameters
  • None
Returns
  • the menubaritem

generateMenuTable

Signature plugins.core.menu.manager.generateMenuTable()
Type Function
Description Generates the Menu Table
Parameters
  • None
Returns
  • The Menu Table

init

Signature plugins.core.menu.manager.init() -> none
Type Function
Description Initialises the module.
Parameters
  • None
Returns
  • None

updateMenubarIcon

Signature plugins.core.menu.manager.updateMenubarIcon(priority) -> none
Type Function
Description Updates the Menubar Icon
Parameters
  • None
Returns
  • None

Fields

displayMenubarAsIcon

Signature plugins.core.menu.manager.displayMenubarAsIcon <cp.prop: boolean>
Type Field
Description If true, the menubar item will be the app icon. If not, it will be the app name.

results matching ""

    No results matching ""