plugins.core.tangent.manager.group.md

docs » plugins.core.tangent.manager.group

---

Represents a Tangent Group. Groups can also be used to enable/disable multiple Parameters/Actions/Menus by enabling/disabling the containing group.

API Overview

• Functions - API calls offered directly by the extension
• is
• Constructors - API calls which return an object, typically one that offers API methods
• group
• Fields - Variables which can only be accessed from an object returned by a constructor
• active
• enabled
• localActive
• Methods - API calls which can only be made on an object returned by a constructor
• action
• binding
• controls
• group
• menu
• name
• parameter
• parent
• reset
• tangent
• xml

API Documentation

Functions

is

Signature	plugins.core.tangent.manager.group.is(thing) -> boolean
Type	Function
Description	Checks if the thing is a group.
Parameters	thing - The thing to check.
Returns	true if it is a group, false otherwise.

Constructors

group

Signature	plugins.core.tangent.manager.group(name, manager, [, parent[, localActive]])
Type	Constructor
Description	Creates a new Group instance.
Parameters	name - The name of the group. manager - The Tangent Manager. parent - The parent group. localActive - If true, this group will ignore the parent's active status when determining its own active status. Defaults to false.

Fields

active

Signature	plugins.core.tangent.manager.group.active <cp.prop: boolean; read-only>
Type	Field
Description	Indicates if the group is active. It will only be active if

enabled

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

localActive

Signature	plugins.core.tangent.manager.group.localActive <cp.prop: boolean>
Type	Field
Description	Indicates if the group should ignore the parent's enabled state when determining if the group is active.

Methods

action

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

binding

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

controls

Signature	plugins.core.tangent.manager.group:controls() -> controls
Type	Method
Description	Retrieves the controls for this group. May be nil if the group was created independently.
Parameters	None
Returns	The controls, or nil.

group

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

menu

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

name

Signature	plugins.core.tangent.manager.group:name() -> string
Type	Method
Description	Returns the name given to the group.
Parameters	None
Returns	The name.

parameter

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

parent

| Signature | plugins.core.tangent.manager.group:parent() -> group | controls | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Returns the parent of the group, which should be either a group, controls or nil. | | Parameters |

• None

| | Returns |

• The group's parents.

|

reset

Signature	plugins.core.tangent.manager.group:reset() -> self
Type	Method
Description	This will remove all parameters, actions, menus and bindings from
Parameters	None
Returns	The group instance.

tangent

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

xml

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