plugins.core.touchbar.manager.md

docs » plugins.core.touchbar.manager

---

Touch Bar Manager Plugin. This handles both the Virtual Touch Bar and adding items to the physical Touch Bar.

Submodules

• plugins.core.touchbar.manager.virtual
• plugins.core.touchbar.manager.widgets

API Overview

• Variables - Configurable values
• closeBox
• defaultGroup
• maxItems
• numberOfSubGroups
• Functions - API calls offered directly by the extension
• activeGroup
• activeSubGroup
• clear
• getAction
• getActionHandlerID
• getActionTitle
• getIcon
• getLabel
• groupStatus
• incrementActiveSubGroup
• start
• stop
• toggle
• touchBar
• update
• updateAction
• updateIcon
• updateLabel
• Fields - Variables which can only be accessed from an object returned by a constructor
• buttons
• enabled
• supported

API Documentation

Variables

closeBox

Signature	plugins.core.touchbar.manager.closeBox -> boolean
Type	Variable
Description	An optional boolean, specifying whether or not the system

defaultGroup

Signature	plugins.core.touchbar.manager.defaultGroup -> string
Type	Variable
Description	The default group.

maxItems

Signature	plugins.core.touchbar.manager.maxItems -> number
Type	Variable
Description	The maximum number of Touch Bar items per group.

numberOfSubGroups

Signature	plugins.core.touchbar.manager.numberOfSubGroups -> number
Type	Variable
Description	The number of Sub Groups per Touch Bar Group.

Functions

activeGroup

Signature	plugins.core.touchbar.manager.activeGroup() -> string
Type	Function
Description	Returns the active group.
Parameters	None
Returns	Returns the active group or manager.defaultGroup as a string.

activeSubGroup

Signature	plugins.core.touchbar.manager.activeSubGroup() -> string
Type	Function
Description	Returns the active sub-group.
Parameters	None
Returns	Returns the active sub group as string

clear

Signature	plugins.core.touchbar.manager.clear() -> none
Type	Function
Description	Clears the Touch Bar items.
Parameters	None
Returns	None

getAction

Signature	plugins.core.touchbar.manager.getAction(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Action.
Parameters	button - Button ID as string group - Group ID as string
Returns	Action as string

getActionHandlerID

Signature	plugins.core.touchbar.manager.getActionHandlerID(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Action Handler ID.
Parameters	button - Button ID as string group - Group ID as string
Returns	Action as string

getActionTitle

Signature	plugins.core.touchbar.manager.getActionTitle(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Action Title.
Parameters	button - Button ID as string group - Group ID as string
Returns	Action as string

getIcon

Signature	plugins.core.touchbar.manager.getIcon(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Icon.
Parameters	button - Button ID as string group - Group ID as string
Returns	Icon data as string

getLabel

Signature	plugins.core.touchbar.manager.getLabel(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Label.
Parameters	button - Button ID as string group - Group ID as string
Returns	Label as string

groupStatus

Signature	plugins.core.touchbar.manager.groupStatus(groupID, status) -> none
Type	Function
Description	Updates a group's visibility status.
Parameters	groupID - the group you want to update as a string. status - the status of the group as a boolean.
Returns	None

incrementActiveSubGroup

Signature	plugins.core.touchbar.manager.incrementActiveSubGroup() -> none
Type	Function
Description	Increments the active sub-group
Parameters	None
Returns	None

start

Signature	plugins.core.touchbar.manager.start() -> none
Type	Function
Description	Starts the CommandPost Touch Bar module.
Parameters	None
Returns	None

stop

Signature	plugins.core.touchbar.manager.stop() -> none
Type	Function
Description	Stops the CommandPost Touch Bar module.
Parameters	None
Returns	None

toggle

Signature	plugins.core.touchbar.manager.toggle() -> none
Type	Function
Description	Toggles the CommandPost Touch Bar module.
Parameters	None
Returns	None

touchBar

Signature	plugins.core.touchbar.manager.touchBar() -> none
Type	Function
Description	Returns the hs._asm.undocumented.touchbar object if it exists.
Parameters	None
Returns	hs._asm.undocumented.touchbar

update

Signature	plugins.core.touchbar.manager.update() -> none
Type	Function
Description	Updates the Touch Bar.
Parameters	None
Returns	None

updateAction

Signature	plugins.core.touchbar.manager.updateAction(button, group, action) -> none
Type	Function
Description	Updates a Touch Bar action.
Parameters	button - Button ID as string group - Group ID as string action - Action as string
Returns	None

updateIcon

Signature	plugins.core.touchbar.manager.updateIcon(button, group, icon) -> none
Type	Function
Description	Updates a Touch Bar icon.
Parameters	button - Button ID as string group - Group ID as string icon - Icon Data as string
Returns	None

updateLabel

Signature	plugins.core.touchbar.manager.updateLabel(button, group, label) -> none
Type	Function
Description	Updates a Touch Bar action.
Parameters	button - Button ID as string group - Group ID as string label - Label as string
Returns	None

Fields

buttons

Signature	plugins.core.touchbar.manager.buttons <cp.prop: table>
Type	Field
Description	Contains all the saved Touch Bar Buttons

enabled

Signature	plugins.core.touchbar.manager.enabled <cp.prop: boolean>
Type	Field
Description	Enable or disable Touch Bar Support.

supported

Signature	plugins.core.touchbar.manager.supported <cp.prop: boolean; read-only>
Type	Field
Description	Is true if the Touch Bar is supported on this version of macOS.