manager

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

Submodules

API Overview

API Documentation

Constants

Signature

plugins.core.touchbar.manager.DEFAULT_GROUP -> string

Type

Constant

Description

The default group.

FILE_NAME

Signature

plugins.core.touchbar.manager.FILE_NAME -> string

Type

Constant

Description

File name of settings file.

Signature

plugins.core.touchbar.manager.FOLDER_NAME -> string

Type

Constant

Description

Folder Name where settings file is contained.

Variables

closeBox

Signature

plugins.core.touchbar.manager.closeBox -> boolean

Type

Variable

Description

An optional boolean, specifying whether or not the system

maxItems

Signature

plugins.core.touchbar.manager.maxItems -> number

Type

Variable

Description

The maximum number of Touch Bar items per group.

Signature

plugins.core.touchbar.manager.numberOfSubGroups -> number

Type

Variable

Description

The number of Sub Groups per Touch Bar Group.

Functions

Signature

plugins.core.touchbar.manager.activeGroup() -> string

Type

Function

Description

Returns the active group.

Parameters

Returns

Signature

plugins.core.touchbar.manager.activeSubGroup() -> string

Type

Function

Description

Returns the active sub-group.

Parameters

Returns

clear

Signature

plugins.core.touchbar.manager.clear() -> none

Type

Function

Description

Clears the Touch Bar items.

Parameters

Returns

getAction

Signature

plugins.core.touchbar.manager.getAction(button, group) -> string

Type

Function

Description

Returns a specific Touch Bar Action.

Parameters

Returns

Signature

plugins.core.touchbar.manager.getActionHandlerID(button, group) -> string

Type

Function

Description

Returns a specific Touch Bar Action Handler ID.

Parameters

Returns

Signature

plugins.core.touchbar.manager.getActionTitle(button, group) -> string

Type

Function

Description

Returns a specific Touch Bar Action Title.

Parameters

Returns

getIcon

Signature

plugins.core.touchbar.manager.getIcon(button, group) -> string

Type

Function

Description

Returns a specific Touch Bar Icon.

Parameters

Returns

getLabel

Signature

plugins.core.touchbar.manager.getLabel(button, group) -> string

Type

Function

Description

Returns a specific Touch Bar Label.

Parameters

Returns

Signature

plugins.core.touchbar.manager.groupStatus(groupID, status) -> none

Type

Function

Description

Updates a group's visibility status.

Parameters

Returns

Signature

plugins.core.touchbar.manager.incrementActiveSubGroup() -> none

Type

Function

Description

Increments the active sub-group

Parameters

Returns

start

Signature

plugins.core.touchbar.manager.start() -> none

Type

Function

Description

Starts the CommandPost Touch Bar module.

Parameters

Returns

stop

Signature

plugins.core.touchbar.manager.stop() -> none

Type

Function

Description

Stops the CommandPost Touch Bar module.

Parameters

Returns

toggle

Signature

plugins.core.touchbar.manager.toggle() -> none

Type

Function

Description

Toggles the CommandPost Touch Bar module.

Parameters

Returns

touchBar

Signature

plugins.core.touchbar.manager.touchBar() -> none

Type

Function

Description

Returns the hs._asm.undocumented.touchbar object if it exists.

Parameters

Returns

update

Signature

plugins.core.touchbar.manager.update() -> none

Type

Function

Description

Updates the Touch Bar.

Parameters

Returns

Signature

plugins.core.touchbar.manager.updateAction(button, group, action) -> none

Type

Function

Description

Updates a Touch Bar action.

Parameters

Returns

Signature

plugins.core.touchbar.manager.updateIcon(button, group, icon) -> none

Type

Function

Description

Updates a Touch Bar icon.

Parameters

Returns

Signature

plugins.core.touchbar.manager.updateLabel(button, group, label) -> none

Type

Function

Description

Updates a Touch Bar action.

Parameters

Returns

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.