This repository was archived by the owner on Jun 9, 2023. It is now read-only.

53 lines (42 loc) · 3.94 KB

docs » cp.apple.finalcutpro.timeline.IndexCaptions

Provides access to the 'Captions' section of the Timeline Index

API Overview

Fields - Variables which can only be accessed from an object returned by a constructor
activate
list
viewErrors
Methods - API calls which can only be made on an object returned by a constructor
doLayout
saveLayout

API Documentation

Fields

activate

Signature	`cp.apple.finalcutpro.timeline.IndexCaptions.activate <cp.ui.RadioButton>`
Type	Field
Description	The RadioButton that activates the 'Captions' section.

list

Signature	`cp.apple.finalcutpro.timeline.IndexCaptions.list <cp.ui.Table>`
Type	Field
Description	The list of captions as a Table.

viewErrors

Signature	`cp.apple.finalcutpro.timeline.IndexCaptions.viewErrors <cp.ui.Button>`
Type	Field
Description	The Button that will allow viewing errors in the Captions list.

Methods

doLayout

Signature	`cp.apple.finalcutpro.timeline.IndexCaptions:doLayout(layout) -> cp.rx.go.Statement`
Type	Method
Description	Returns a Statement that will apply the layout provided, if possible.
Parameters	layout - the `table` containing the layout configuration. Usually created via the [#saveLayout] method.
Returns	The Statement.

saveLayout

Signature	`cp.apple.finalcutpro.timeline.IndexCaptions:saveLayout() -> table`
Type	Method
Description	Returns a `table` containing the layout configuration for this class.
Returns	The layout configuration `table`.