# cp.apple.finalcutpro.timeline.Index

Timeline Index Module.


# API Overview

Functions - API calls offered directly by the extension

  • matches

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

  • Index

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

  • captions
  • clips
  • mode
  • roles
  • search
  • tags

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

  • activeTab
  • doHide
  • doLayout
  • doShow
  • saveLayout

# API Documentation

# Functions

# matches

Signature cp.apple.finalcutpro.timeline.Index.matches(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 26

# Constructors

# Index

Signature cp.apple.finalcutpro.timeline.Index(timeline) -> cp.apple.finalcutpro.timeline.Index
Type Constructor
Description Creates a new Timeline Index.
Parameters
Returns
  • A new Index instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 41

# Fields

# captions

Signature cp.apple.finalcutpro.timeline.Index.captions <cp.apple.finalcutpro.timeline.IndexCaptions>
Type Field
Description The IndexCaptions.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 123

# clips

Signature cp.apple.finalcutpro.timeline.Index.clips <cp.apple.finalcutpro.timeline.IndexClips>
Type Field
Description The IndexClips.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 102

# mode

Signature cp.apple.finalcutpro.timeline.Index.mode <cp.apple.finalcutpro.timeline.IndexMode>
Type Field
Description The IndexMode for the Index.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 69

# roles

Signature cp.apple.finalcutpro.timeline.Index.roles <cp.apple.finalcutpro.timeline.IndexRoles>
Type Field
Description The IndexRoles.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 116

# search

Signature cp.apple.finalcutpro.timeline.Index.search <cp.ui.SearchField>
Type Field
Description The SearchField for the Timeline Index.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 60

# tags

Signature cp.apple.finalcutpro.timeline.Index.tags <cp.apple.finalcutpro.timeline.IndexTags>
Type Field
Description The IndexTags.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 109

# Methods

# activeTab

Signature cp.apple.finalcutpro.timeline.Index:activeTab() -> object
Type Method
Description Gets the active tab.
Parameters
  • None
Returns
  • The active tab or nil.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 130

# doHide

Signature cp.apple.finalcutpro.timeline.Index:doHide() -> cp.rx.go.Statement
Type Method
Description Returns a Statement which will hide the Index if possible.
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 89

# doLayout

Signature cp.apple.finalcutpro.timeline.Index: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
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 174

# doShow

Signature cp.apple.finalcutpro.timeline.Index:doShow() -> cp.rx.go.Statement
Type Method
Description Returns a Statement which will show the Index if possible.
Parameters
  • None
Returns
  • Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 76

# saveLayout

Signature cp.apple.finalcutpro.timeline.Index:saveLayout() -> table
Type Method
Description Returns a table containing the layout configuration for this class.
Parameters
  • None
Returns
  • The layout configuration table.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/Index.lua line 151