manager

Last updated last month

Manager for the CommandPost Preferences Window.

Submodules

API Overview

API Documentation

Constants

Signature

plugins.core.preferences.manager.DEFAULT_HEIGHT -> number

Type

Constant

Description

Default Height of Preferences Window

Signature

plugins.core.preferences.manager.DEFAULT_TITLE -> string

Type

Constant

Description

Default Title of Preferences Window

Signature

plugins.core.preferences.manager.DEFAULT_WIDTH -> number

Type

Constant

Description

Default Width of Preferences Window

Signature

plugins.core.preferences.manager.DEFAULT_WINDOW_STYLE -> table

Type

Constant

Description

Default Webview Window Style of Preferences Window

lastTab

Signature

plugins.core.preferences.manager.lastTab

Type

Constant

Description

Returns the last tab saved in settings.

position

Signature

plugins.core.preferences.manager.position

Type

Constant

Description

Returns the last frame saved in settings.

Signature

plugins.core.preferences.manager.WEBVIEW_LABEL -> string

Type

Constant

Description

The WebView Label

Variables

_handlers

Signature

plugins.core.preferences.manager._handlers -> table

Type

Variable

Description

Table containing handlers.

_panels

Signature

plugins.core.preferences.manager._panels -> table

Type

Variable

Description

Table containing panels.

Functions

Signature

plugins.core.preferences.manager.addHandler(id, handlerFn) -> string

Type

Function

Description

Adds a Handler

Parameters

Returns

addPanel

Signature

plugins.core.preferences.manager.addPanel(params) -> plugins.core.preferences.manager.panel

Type

Function

Description

Adds a new panel with the specified params to the preferences manager.

Parameters

Returns

Notes

focus

Signature

plugins.core.preferences.manager.focus() -> boolean

Type

Function

Description

Puts focus on the Preferences Window.

Parameters

Returns

Signature

plugins.core.preferences.manager.getHandler(id) -> string

Type

Function

Description

Returns the handler for a given ID.

Parameters

Returns

getLabel

Signature

plugins.core.preferences.manager.getLabel() -> string

Type

Function

Description

Returns the Webview label.

Parameters

Returns

Signature

plugins.core.preferences.manager.getWebview() -> hs.webview

Type

Function

Description

Returns the Webview of the Preferences Window.

Parameters

Returns

hide

Signature

plugins.core.preferences.manager.hide() -> none

Type

Function

Description

Hides the Preferences Window.

Parameters

Returns

init

Signature

plugins.core.preferences.manager.init() -> nothing

Type

Function

Description

Initialises the preferences panel.

Parameters

Returns

Signature

plugins.core.preferences.manager.injectScript(script) -> none

Type

Function

Description

Injects JavaScript into the Preferences Webview.

Parameters

Returns

Signature

plugins.core.preferences.manager.maxPanelHeight() -> number

Type

Function

Description

Returns the maximum size defined by a panel.

Parameters

Returns

new

Signature

plugins.core.preferences.manager.new() -> none

Type

Function

Description

Creates a new Preferences Window.

Parameters

Returns

refresh

Signature

plugins.core.preferences.manager.refresh() -> none

Type

Function

Description

Refreshes the Preferences Window.

Parameters

Returns

Signature

plugins.core.preferences.manager.selectPanel(id) -> none

Type

Function

Description

Selects a Preferences Panel.

Parameters

Returns

Signature

plugins.core.preferences.manager.setPanelRenderer(renderer) -> none

Type

Function

Description

Sets a Panel Renderer

Parameters

Returns

show

Signature

plugins.core.preferences.manager.show() -> boolean

Type

Function

Description

Shows the Preferences Window

Parameters

Returns