#cp.apple.finalcutpro.timeline.Index

Timeline Index Module.


#API Overview

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

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

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Functions

Signaturecp.apple.finalcutpro.timeline.Index.matches(element) -> boolean
TypeFunction
DescriptionChecks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 26

#Constructors

Signaturecp.apple.finalcutpro.timeline.Index(timeline) -> cp.apple.finalcutpro.timeline.Index
TypeConstructor
DescriptionCreates a new Timeline Index.
Parameters
Returns
  • A new Index instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 41

#Fields

Signaturecp.apple.finalcutpro.timeline.Index.captions <cp.apple.finalcutpro.timeline.IndexCaptions>
TypeField
DescriptionThe IndexCaptions.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 123

Signaturecp.apple.finalcutpro.timeline.Index.clips <cp.apple.finalcutpro.timeline.IndexClips>
TypeField
DescriptionThe IndexClips.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 102

Signaturecp.apple.finalcutpro.timeline.Index.mode <cp.apple.finalcutpro.timeline.IndexMode>
TypeField
DescriptionThe IndexMode for the Index.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 69

Signaturecp.apple.finalcutpro.timeline.Index.roles <cp.apple.finalcutpro.timeline.IndexRoles>
TypeField
DescriptionThe IndexRoles.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 116

Signaturecp.apple.finalcutpro.timeline.Index.search <cp.ui.SearchField>
TypeField
DescriptionThe SearchField for the Timeline Index.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 60

Signaturecp.apple.finalcutpro.timeline.Index.tags <cp.apple.finalcutpro.timeline.IndexTags>
TypeField
DescriptionThe IndexTags.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 109

#Methods

Signaturecp.apple.finalcutpro.timeline.Index:activeTab() -> object
TypeMethod
DescriptionGets the active tab.
Parameters
  • None
Returns
  • The active tab or nil.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 130

Signaturecp.apple.finalcutpro.timeline.Index:doHide() -> cp.rx.go.Statement
TypeMethod
DescriptionReturns a Statement which will hide the Index if possible.
Parameters
  • None
Returns
  • Statement
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 89

Signaturecp.apple.finalcutpro.timeline.Index:doLayout(layout) -> cp.rx.go.Statement
TypeMethod
DescriptionReturns 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
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 174

Signaturecp.apple.finalcutpro.timeline.Index:doShow() -> cp.rx.go.Statement
TypeMethod
DescriptionReturns a Statement which will show the Index if possible.
Parameters
  • None
Returns
  • Statement
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 76

Signaturecp.apple.finalcutpro.timeline.Index:saveLayout() -> table
TypeMethod
DescriptionReturns a table containing the layout configuration for this class.
Parameters
  • None
Returns
  • The layout configuration table.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/Index.lua line 151