plugins.core.touchbar.virtual.md

docs » plugins.core.touchbar.virtual

---

Virtual Touch Bar Manager

API Overview

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

API Documentation

Constants

LOCATION_DEFAULT_VALUE

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

LOCATION_DRAGGABLE

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

LOCATION_MOUSE

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

Variables

updateLocationCallback

Signature	plugins.core.touchbar.virtual.updateLocationCallback -> table
Type	Variable
Description	Update Location Callback

Functions

callback

Signature	plugins.core.touchbar.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.virtual.hide() -> none
Type	Function
Description	Hide the Virtual Touch Bar
Parameters	None
Returns	None

init

Signature	plugins.core.touchbar.virtual.init() -> self
Type	Function
Description	Initialise the module.
Parameters	None
Returns	Self

show

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

start

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

stop

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

touchbar

Signature	plugins.core.touchbar.virtual.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.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.virtual.enabled <cp.prop: boolean>
Type	Field
Description	Is true if the plugin is enabled.

isActive

Signature	plugins.core.touchbar.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.virtual.lastLocation <cp.prop: point table>
Type	Field
Description	The last known Virtual Touch Bar Location

supported

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