#plugins.finalcutpro.pasteboard.history

Pasteboard History

#API Overview

Constants - Useful values which cannot be changed

FILE_NAME
FOLDER_NAME
HISTORY_MAXIMUM_SIZE

Functions - API calls offered directly by the extension

addHistoryItem
clearHistory
doPasteHistoryItem
init
update

Fields - Variables which can only be accessed from an object returned by a constructor

_history
enabled

#API Documentation

#Constants

#FILE_NAME


Signature	`plugins.finalcutpro.pasteboard.history.FILE_NAME -> string`
Type	Constant
Description	File name of settings file.
Notes	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 25

#FOLDER_NAME


Signature	`plugins.finalcutpro.pasteboard.history.FOLDER_NAME -> string`
Type	Constant
Description	Folder Name where settings file is contained.
Notes	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 30

#HISTORY_MAXIMUM_SIZE


Signature	`plugins.finalcutpro.pasteboard.history.HISTORY_MAXIMUM_SIZE -> number`
Type	Constant
Description	Maximum Size of Pasteboard History
Notes	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 35

#Functions

#addHistoryItem


Signature	`plugins.finalcutpro.pasteboard.history.addHistoryItem(data, label) -> none`
Type	Function
Description	Adds an item to the Pasteboard history.
Parameters	data - The data label - The label
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 63

#clearHistory


Signature	`plugins.finalcutpro.pasteboard.history.clearHistory() -> none`
Type	Function
Description	Clears the Pasteboard History.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 50

#doPasteHistoryItem


Signature	`plugins.finalcutpro.pasteboard.history.doPasteHistoryItem(index) -> cp.rx.go.Statement`
Type	Function
Description	Returns a function which will paste a Pasteboard History Item when executed.
Parameters	index - The index of the Pasteboard history item.
Returns	A Statement to be executed.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 95

#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
Notes	None
Examples	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 191

#update


Signature	`plugins.finalcutpro.pasteboard.history.update() -> none`
Type	Function
Description	Enable or disable the Pasteboard History.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 167

#Fields

#_history


Signature	`plugins.finalcutpro.pasteboard.history._history <cp.prop: table>`
Type	Field
Description	Contains all the saved Touch Bar Buttons
Notes	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 45

#enabled


Signature	`plugins.finalcutpro.pasteboard.history.enabled <cp.prop: boolean>`
Type	Field
Description	Enable or disable the Pasteboard History.
Notes	None
Source	src/plugins/finalcutpro/pasteboard/history.lua line 40