history

Pasteboard History

API Overview

API Documentation

Constants

FILE_NAME

Signature

plugins.finalcutpro.pasteboard.history.FILE_NAME -> string

Type

Constant

Description

File name of settings file.

Signature

plugins.finalcutpro.pasteboard.history.FOLDER_NAME -> string

Type

Constant

Description

Folder Name where settings file is contained.

Signature

plugins.finalcutpro.pasteboard.history.HISTORY_MAXIMUM_SIZE -> number

Type

Constant

Description

Maximum Size of Pasteboard History

Functions

Signature

plugins.finalcutpro.pasteboard.history.addHistoryItem(data, label) -> none

Type

Function

Description

Adds an item to the Pasteboard history.

Parameters

None

Returns

None

Signature

plugins.finalcutpro.pasteboard.history.clearHistory() -> none

Type

Function

Description

Clears the Pasteboard History.

Parameters

None

Returns

None

Signature

plugins.finalcutpro.pasteboard.history.getHistory() -> table

Type

Function

Description

Gets the Pasteboard History.

Parameters

None

Returns

A table of the Pasteboard history.

init

Signature

plugins.finalcutpro.pasteboard.history.init(manager) -> Pasteboard History Object

Type

Function

Description

Initialises the module.

Parameters

manager - The Pasteboard manager object.

Returns

Pasteboard History Object

Signature

plugins.finalcutpro.pasteboard.history.pasteHistoryItem(index) -> none

Type

Function

Description

Pastes a Pasteboard History Item.

Parameters

index - The index of the Pasteboard history item.

Returns

None

Signature

plugins.finalcutpro.pasteboard.history.setHistory(history) -> none

Type

Function

Description

Sets the Pasteboard History.

Parameters

history - The history in a table.

Returns

None

update

Signature

plugins.finalcutpro.pasteboard.history.update() -> none

Type

Function

Description

Enable or disable the Pasteboard History.

Parameters

None

Returns

None

Fields

_history

Signature

plugins.finalcutpro.pasteboard.history._history <cp.prop: table>

Type

Field

Description

Contains all the saved Touch Bar Buttons

enabled

Signature

plugins.finalcutpro.pasteboard.history.enabled <cp.prop: boolean>

Type

Field

Description

Enable or disable the Pasteboard History.