# plugins.core.menu.manager.section
Controls sections for the CommandPost menu.
---
## API Overview
**Constants** - _Useful values which cannot be changed_
* [DEFAULT_PRIORITY](#default_priority)
* [SECTION_DISABLED_PREFERENCES_KEY_PREFIX](#section_disabled_preferences_key_prefix)
**Methods** - _API calls which can only be made on an object returned by a constructor_
* [addApplicationHeading](#addapplicationheading)
* [addHeading](#addheading)
* [addItem](#additem)
* [addItems](#additems)
* [addMenu](#addmenu)
* [addSection](#addsection)
* [addSeparator](#addseparator)
* [generateTable](#generatetable)
* [getDisabledPreferenceKey](#getdisabledpreferencekey)
* [isApplicationHeading](#isapplicationheading)
* [isDisabled](#isdisabled)
* [new](#new)
* [setDisabledFn](#setdisabledfn)
* [setDisabledPreferenceKey](#setdisabledpreferencekey)
---
## API Documentation
#### Constants
### [DEFAULT_PRIORITY](#default_priority)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.menu.manager.section.DEFAULT_PRIORITY -> number` |
| **Type** | Constant |
| **Description** | The default priority |
| **Notes** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 12](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L12) |
---
### [SECTION_DISABLED_PREFERENCES_KEY_PREFIX](#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. |
| **Notes** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 17](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L17) |
---
#### Methods
### [addApplicationHeading](#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.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 172](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L172) |
---
### [addHeading](#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.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 148](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L148) |
---
### [addItem](#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.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 110](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L110) |
---
### [addItems](#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.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 129](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L129) |
---
### [addMenu](#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 the items in the menu is returned. |
| **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.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 223](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L223) |
---
### [addSection](#addsection)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.menu.manager.section:addSection(priority) -> 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.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 244](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L244) |
---
### [addSeparator](#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.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 208](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L208) |
---
### [generateTable](#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** | |
| **Returns** | - `table` - The menu table for this section. See `hs.menubar` for details on the format.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 263](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L263) |
---
### [getDisabledPreferenceKey](#getdisabledpreferencekey)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.menu.manager.section:getDisabledPreferenceKey() -> string` |
| **Type** | Method |
| **Description** | Gets the disabled preferences key. |
| **Parameters** | |
| **Returns** | - `true` if the section has a disabled preferences key defined, otherwise `false`.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 69](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L69) |
---
### [isApplicationHeading](#isapplicationheading)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.menu.manager.section:isApplicationHeading() -> boolean` |
| **Type** | Method |
| **Description** | Does this section contain an application heading? |
| **Parameters** | |
| **Returns** | - `true` if it does contain an application heading, otherwise `false`.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 195](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L195) |
---
### [isDisabled](#isdisabled)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.menu.manager.section:isDisabled() -> boolean` |
| **Type** | Method |
| **Description** | Gets the disabled status |
| **Parameters** | |
| **Returns** | - `true` if the section is disabled, otherwise `false`
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 82](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L82) |
---
### [new](#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** | |
| **Returns** | - section - The section that was created.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 22](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L22) |
---
### [setDisabledFn](#setdisabledfn)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.menu.manager.section:setDisabledFn(disabledFn) -> self` |
| **Type** | Method |
| **Description** | Sets the Disabled Function |
| **Parameters** | - disabledFn - The disabled function.
|
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 55](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L55) |
---
### [setDisabledPreferenceKey](#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** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/menu/manager/section.lua line 41](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/menu/manager/section.lua#L41) |
---
---