manager

Last updated last month

Manager for the CommandPost Watch Folders Panel.

Submodules

API Overview

API Documentation

Constants

Signature

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

Type

Constant

Description

Default Height of the Watch Folder Window

Signature

plugins.core.watchfolders.manager.DEFAULT_TITLE -> number

Type

Constant

Description

Default Title of the Watch Folder Window

Signature

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

Type

Constant

Description

Default Width of the Watch Folder Window

Signature

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

Type

Constant

Description

Table of Default Window Style

position

Signature

plugins.core.watchfolders.manager.position <cp.prop: table>

Type

Constant

Description

Returns the last frame saved in settings.

Signature

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

Type

Constant

Description

WebView Label

Functions

Signature

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

Type

Function

Description

Adds a Handler

Parameters

Returns

addPanel

Signature

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

Type

Function

Description

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

Parameters

Returns

Notes

Signature

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

Type

Function

Description

Returns the handler for a given ID.

Parameters

Returns

getLabel

Signature

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

Type

Function

Description

Returns the Webview label.

Parameters

Returns

hide

Signature

plugins.core.watchfolders.manager.hide() -> boolean

Type

Function

Description

Hides the Watch Folders Window

Parameters

Returns

init

Signature

plugins.core.watchfolders.manager.init() -> none

Type

Function

Description

Initialises the Watch Folder Manager.

Parameters

Returns

Signature

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

Type

Function

Description

Injects JavaScript into the Watch Folders Webview.

Parameters

Returns

Signature

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

Type

Function

Description

Gets the maximum panel height as a number

Parameters

Returns

Signature

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

Type

Function

Description

Selects a Preferences Panel.

Parameters

Returns

Signature

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

Type

Function

Description

Sets a Panel Renderer

Parameters

Returns

show

Signature

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

Type

Function

Description

Shows the Watch Folders Window

Parameters

Returns