plugins.core.menu.manager

Menu Manager Plugin.

---

Submodules

• plugins.core.menu.manager.section

---

API Overview

Variables - Configurable values

• rootSection
• titleSuffix

Functions - API calls offered directly by the extension

• addSection
• addTitleSuffix
• disable
• enable
• generateMenuTable
• init
• updateMenubarIcon

Fields - Variables which can only be accessed from an object returned by a constructor

• displayMenubarAsIcon

---

API Documentation

Variables

rootSection

Signature	plugins.core.menu.manager.rootSection() -> section
Type	Variable
Description	A new Root Section
Notes	None
Source	src/plugins/core/menu/manager/init.lua line 23

---

titleSuffix

Signature	plugins.core.menu.manager.titleSuffix() -> table
Type	Variable
Description	Table of Title Suffix's
Notes	None
Source	src/plugins/core/menu/manager/init.lua line 28

---

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.
Notes	None
Examples	None
Source	src/plugins/core/menu/manager/init.lua line 148

---

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
Notes	None
Examples	None
Source	src/plugins/core/menu/manager/init.lua line 161

---

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
Notes	None
Examples	None
Source	src/plugins/core/menu/manager/init.lua line 63

---

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
Notes	None
Examples	None
Source	src/plugins/core/menu/manager/init.lua line 78

---

generateMenuTable

Signature	plugins.core.menu.manager.generateMenuTable()
Type	Function
Description	Generates the Menu Table
Parameters	None
Returns	The Menu Table
Notes	None
Examples	None
Source	src/plugins/core/menu/manager/init.lua line 175

---

init

Signature	plugins.core.menu.manager.init() -> none
Type	Function
Description	Initialises the module.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/menu/manager/init.lua line 33

---

updateMenubarIcon

Signature	plugins.core.menu.manager.updateMenubarIcon(priority) -> none
Type	Function
Description	Updates the Menubar Icon
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/menu/manager/init.lua line 93

---

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.
Notes	None
Source	src/plugins/core/menu/manager/init.lua line 143

---

---