panel

Last updated 23 days ago

CommandPost Preferences Panel.

API Overview

API Documentation

Constants

Signature

plugins.core.preferences.manager.panel.DEFAULT_PRIORITY -> number

Type

Constant

Description

The default priority for panels.

Signature

plugins.core.preferences.manager.panel.HANDLER_PRIORITY -> number

Type

Constant

Description

The default priority for handler scripts.

Constructors

new

Signature

plugins.core.preferences.manager.panel.new(priority, id) -> cp.core.preferences.manager.panel

Type

Constructor

Description

Constructs a new panel with the specified priority and ID.

Parameters

Methods

addButton

Signature

plugins.core.preferences.manager.panel:addButton(params) -> panel

Type

Method

Description

Adds a button to the panel.

Parameters

Returns

Notes

Signature

plugins.core.preferences.manager.panel:addCheckbox(priority, params) -> panel

Type

Method

Description

Adds a checkbox to the panel with the specified priority and params.

Parameters

Returns

Notes

Signature

plugins.core.preferences.manager.panel:addContent(priority, content[, escaped]) -> panel

Type

Method

Description

Adds the specified content to the panel, with the specified priority order.

Parameters

Returns

Signature

plugins.core.preferences.manager.panel:addHandler(event, id, handlerFn, keys) -> none

Type

Method

Description

Gets a handler from an Handler ID

Parameters

Returns

Signature

plugins.core.preferences.manager.panel:addHeading(text) -> panel

Type

Method

Description

Adds a heading to the panel

Parameters

Returns

Signature

plugins.core.preferences.manager.panel:addParagraph(content[, escaped[, class]]) -> panel

Type

Method

Description

Adds a Paragraph to the panel

Parameters

Returns

Signature

plugins.core.preferences.manager.panel:addPassword(params) -> panel

Type

Method

Description

Adds a password text-box to the panel.

Parameters

Returns

addSelect

Signature

plugins.core.preferences.manager.panel:addSelect(params) -> panel

Type

Method

Description

Adds a select to the panel.

Parameters

Returns

Signature

plugins.core.preferences.manager.panel:addTextbox(params) -> panel

Type

Method

Description

Adds a text-box to the panel

Parameters

Returns

Signature

plugins.core.preferences.manager.panel:getToolbarItem() -> table

Type

Method

Description

Gets the Tool Bar as a table

Parameters

Returns