controls

Represents a Tangent Group

API Overview

  • Constants - Useful values which cannot be changed

  • Constructors - API calls which return an object, typically one that offers API methods

    • ​new​

  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Constants

​controls​

Signature

plugins.core.tangent.manager.controls

Type

Constant

Description

The set of controls currently registered.

Constructors

​new​

Signature

plugins.core.tangent.manager.controls.new(id, name)

Type

Constructor

Description

Creates a new Group instance.

Parameters

​

Methods

​action​

Signature

plugins.core.tangent.manager.controls:action(id[, name]) -> action

Type

Method

Description

Adds an action to this controls.

Returns

​

​controls​

Signature

plugins.core.tangent.manager.controls:controls() -> controls

Type

Method

Description

Returns this controls instance.

Parameters

​

Returns

​

​findByID​

Signature

plugins.core.tangent.manager.controls:findByID(id) -> table

Type

Method

Description

Finds a control (Action/Parameter/Mode) by its unique ID.

Parameters

​

Returns

​

​group​

Signature

plugins.core.tangent.manager.controls:group(name) -> group

Type

Method

Description

Adds a subgroup to this group.

Returns

​

Signature

plugins.core.tangent.manager.controls:menu(id[, name]) -> menu

Type

Method

Description

Adds an menu to this controls.

Returns

​

​parameter​

Signature

plugins.core.tangent.manager.controls:parameter(id[, name]) -> parameter

Type

Method

Description

Adds an parameter to this controls.

Returns

​

​parent​

Signature

plugins.core.tangent.manager.controls:parent() -> nil

Type

Method

Description

Always returns nil, sinces controls have no parent.

Parameters

​

Returns

​

​register​

Signature

plugins.core.tangent.manager.controls:register(control) -> self

Type

Method

Description

Registers a control (Action/Parameter/Menu) with it's ID

Parameters

​

Returns

​

​unregister​

Signature

plugins.core.tangent.manager.controls:unregister(control) -> self

Type

Method

Description

Unregisters a control (Action/Parameter/Menu) with it's ID

Parameters

​

Returns

​

​xml​

Signature

plugins.core.tangent.manager.controls:xml() -> cp.web.xml

Type

Method

Description

Returns the xml configuration for the Group.

Parameters

​

Returns

​