plugins.core.tangent.manager.controls.md

docs » plugins.core.tangent.manager.controls

---

Represents a Tangent Group

API Overview

• Constructors - API calls which return an object, typically one that offers API methods
• controls
• Fields - Variables which can only be accessed from an object returned by a constructor
• active
• enabled
• Methods - API calls which can only be made on an object returned by a constructor
• action
• controls
• findByID
• group
• menu
• parameter
• parent
• register
• tangent
• unregister
• xml

API Documentation

Constructors

controls

Signature	plugins.core.tangent.manager.controls(id, name)
Type	Constructor
Description	Creates a new Group instance.
Parameters	name - The name of the controls.

Fields

active

Signature	plugins.core.tangent.manager.controls.active <cp.prop: boolean; read-only>
Type	Field
Description	Indicates if the controls are active. They will be active if enabled is true.

enabled

Signature	plugins.core.tangent.manager.controls.enabled <cp.prop: boolean>
Type	Field
Description	Indicates if the controls are enabled.

Methods

action

Signature	plugins.core.tangent.manager.controls:action(id[, name]) -> action
Type	Method
Description	Adds an action to this controls.
Returns	The new action

controls

Signature	plugins.core.tangent.manager.controls:controls() -> controls
Type	Method
Description	Returns this controls instance.
Parameters	None
Returns	The `controls instance.

findByID

Signature	plugins.core.tangent.manager.controls:findByID(id) -> table
Type	Method
Description	Finds a control (Action/Parameter/Mode) by its unique ID.
Parameters	id - the ID to search by
Returns	The control, or nil if not found.

group

Signature	plugins.core.tangent.manager.controls:group(name) -> group
Type	Method
Description	Adds a subgroup to this group.
Returns	The new group

menu

Signature	plugins.core.tangent.manager.controls:menu(id[, name]) -> menu
Type	Method
Description	Adds an menu to this controls.
Returns	The new menu

parameter

Signature	plugins.core.tangent.manager.controls:parameter(id[, name]) -> parameter
Type	Method
Description	Adds an parameter to this controls.
Returns	The new parameter

parent

Signature	plugins.core.tangent.manager.controls:parent() -> nil
Type	Method
Description	Always returns nil, sinces controls have no parent.
Parameters	None
Returns	nil.

register

Signature	plugins.core.tangent.manager.controls:register(control) -> self
Type	Method
Description	Registers a control (Action/Parameter/Menu) with it's ID
Parameters	control - The Action/Parameter/Menu to register
Returns	self

tangent

Signature	plugins.core.tangent.manager.controls:tangent() -> hs.tangent
Type	Method
Description	The hs.tangent connection.
Parameters	None
Returns	The hs.tangent.

unregister

Signature	plugins.core.tangent.manager.controls:unregister(control) -> self
Type	Method
Description	Unregisters a control (Action/Parameter/Menu) with it's ID
Parameters	control - The Action/Parameter/Menu to unregister
Returns	self

xml

Signature	plugins.core.tangent.manager.controls:xml() -> cp.web.xml
Type	Method
Description	Returns the xml configuration for the Group.
Parameters	None
Returns	The xml for the Group.