plugins.core.menu.manager.section.md

docs » plugins.core.menu.manager.section

---

Controls sections for the CommandPost menu.

API Overview

• Constants - Useful values which cannot be changed
• DEFAULT_PRIORITY
• SECTION_DISABLED_PREFERENCES_KEY_PREFIX
• Methods - API calls which can only be made on an object returned by a constructor
• addApplicationHeading
• addHeading
• addItem
• addItems
• addMenu
• addSection
• addSeparator
• generateTable
• getDisabledPreferenceKey
• isApplicationHeading
• isDisabled
• new
• setDisabledFn
• setDisabledPreferenceKey

API Documentation

Constants

DEFAULT_PRIORITY

Signature	plugins.core.menu.manager.section.DEFAULT_PRIORITY -> number
Type	Constant
Description	The default priority

SECTION_DISABLED_PREFERENCES_KEY_PREFIX

Signature	plugins.core.menu.manager.section.SECTION_DISABLED_PREFERENCES_KEY_PREFIX -> string
Type	Constant
Description	The preferences key prefix for a disabled section.

Methods

addApplicationHeading

Signature	plugins.core.menu.manager.section:addApplicationHeading(title) -> section
Type	Method
Description	Adds a heading to the top of the section.
Parameters	title - The title of the Application Heading.
Returns	section - The new section that was created.

addHeading

Signature	plugins.core.menu.manager.section:addHeading(title) -> section
Type	Method
Description	Adds a heading to the top of a section.
Parameters	title - The title of the heading.
Returns	section - The new section that was created.

addItem

Signature	plugins.core.menu.manager.section:addItem(priority, itemFn) -> section
Type	Method
Description	Registers a function which will generate a single table item.
Parameters	priority - The priority of the item within the section. Lower numbers appear first. itemFn - A function which will return a table representing a single menu item. See hs.menubar for details.
Returns	section - The section the item was added to.

addItems

Signature	plugins.core.menu.manager.section:addItems(priority, itemsFn) -> section
Type	Method
Description	Registers a function which will generate multiple table items.
Parameters	priority - The priority of the items within the section. Lower numbers appear first. itemsFn - A function which will return a table containing multiple table items. See hs.menubar for details.
Returns	section - The section the item was added to.

addMenu

Signature	plugins.core.menu.manager.section:addMenu(priority, titleFn) -> section
Type	Method
Description	Adds a new sub-menu with the specified priority. The section that will contain
Parameters	priority - The priority of the item within the section. Lower numbers appear first. titleFn - The function which will return the menu title.
Returns	section - The new section that was created.

addSection

Signature	plugins.core.menu.manager.section:addSection(priority, itemFn) -> section
Type	Method
Description	Adds a new sub-section with the specified priority. The new sub-section is returned.
Parameters	priority - The priority of the item within the section. Lower numbers appear first.
Returns	section - The new section that was created.

addSeparator

Signature	plugins.core.menu.manager.section:addSeparator(priority) -> section
Type	Method
Description	Adds a new seperator with specified priority.
Parameters	priority - The priority of the items within the section. Lower numbers appear first.
Returns	section - The new section that was created.

generateTable

Signature	plugins.core.menu.manager.section:generateTable() -> table
Type	Method
Description	Generates a new menu table based on the registered items and sections inside this section.
Parameters	None
Returns	table - The menu table for this section. See hs.menubar for details on the format.

getDisabledPreferenceKey

Signature	plugins.core.menu.manager.section:getDisabledPreferenceKey() -> string
Type	Method
Description	Gets the disabled preferences key.
Parameters	None
Returns	true if the section has a disabled preferences key defined, otherwise false.

isApplicationHeading

Signature	plugins.core.menu.manager.section:isApplicationHeading() -> boolean
Type	Method
Description	Does this section contain an application heading?
Parameters	None
Returns	true if it does contain an application heading, otherwise false.

isDisabled

Signature	plugins.core.menu.manager.section:isDisabled() -> boolean
Type	Method
Description	Gets the disabled status
Parameters	None
Returns	true if the section is disabled, otherwise false

new

Signature	plugins.core.menu.manager.section:new() -> section
Type	Method
Description	Creates a new menu section, which can have items and sub-menus added to it.
Parameters	None
Returns	section - The section that was created.

setDisabledFn

Signature	plugins.core.menu.manager.section:setDisabledFn(disabledFn) -> self
Type	Method
Description	Sets the Disabled Function
Parameters	disabledFn - The disabled function.
Returns	Self

setDisabledPreferenceKey

Signature	plugins.core.menu.manager.section:setDisabledPreferenceKey(key) -> self
Type	Method
Description	Sets the Disabled Preferences Key.
Parameters	key - A string which contains the unique preferences key.
Returns	Self