plugins.core.touchbar.manager.virtual.md

docs » plugins.core.touchbar.manager.virtual

---

Virtual Touch Bar Manager

Submodules

• plugins.core.touchbar.manager.virtual.updateLocationCallback

API Overview

• Constants - Useful values which cannot be changed
• LOCATION_DEFAULT_VALUE
• LOCATION_DRAGGABLE
• LOCATION_MOUSE
• Functions - API calls offered directly by the extension
• callback
• hide
• show
• start
• stop
• update
• Fields - Variables which can only be accessed from an object returned by a constructor
• enabled
• isActive
• lastLocation

API Documentation

Constants

LOCATION_DEFAULT_VALUE

Signature	plugins.core.touchbar.manager.virtual.LOCATION_DEFAULT_VALUE -> string
Type	Constant
Description	Default location value.

LOCATION_DRAGGABLE

Signature	plugins.core.touchbar.manager.virtual.LOCATION_DRAGGABLE -> string
Type	Constant
Description	Location is Draggable.

LOCATION_MOUSE

Signature	plugins.core.touchbar.manager.virtual.LOCATION_MOUSE -> string
Type	Constant
Description	Location is Mouse.

Functions

callback

Signature	plugins.core.touchbar.manager.virtual.callback() -> none
Type	Function
Description	Callback Function for the Virtual Touch Bar
Parameters	obj - the touchbarObject the callback is for message - the message to the callback, either "didEnter" or "didExit"
Returns	None

hide

Signature	plugins.core.touchbar.manager.virtual.hide() -> none
Type	Function
Description	Hide the Virtual Touch Bar
Parameters	None
Returns	None

show

Signature	plugins.core.touchbar.manager.virtual.show() -> none
Type	Function
Description	Show the Virtual Touch Bar
Parameters	None
Returns	None

start

Signature	plugins.core.touchbar.manager.virtual.start() -> none
Type	Function
Description	Initialises the Virtual Touch Bar
Parameters	None
Returns	None

stop

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

update

Signature	plugins.core.touchbar.manager.virtual.update() -> none
Type	Function
Description	Updates the visibility and location of the Virtual Touch Bar
Parameters	None
Returns	None

Fields

enabled

Signature	plugins.core.touchbar.manager.virtual.enabled <cp.prop: boolean>
Type	Field
Description	Is true if the plugin is enabled.

isActive

Signature	plugins.core.touchbar.manager.virtual.isActive <cp.prop: boolean; read-only>
Type	Field
Description	Is true if the plugin is enabled and the TouchBar is supported on this OS.

lastLocation

Signature	plugins.core.touchbar.manager.virtual.lastLocation <cp.prop: point table>
Type	Field
Description	The last known Virtual Touch Bar Location