# cp.apple.finalcutpro.timeline.IndexMode

Timeline Index Mode Radio Group 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

  • IndexMode

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

  • captions
  • clips
  • roles
  • tags

# API Documentation

# Functions

# matches

Signature cp.apple.finalcutpro.timeline.IndexMode.matches(element) -> boolean
Type Function
Description Checks if the element is the IndexMode.
Parameters
  • element - The axuielement to check.
Returns
  • true if it matches, otherwise false.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexMode.lua line 30

# Constructors

# IndexMode

Signature cp.apple.finalcutpro.timeline.IndexMode(index) -> cp.apple.finalcutpro.timeline.IndexMode
Type Constructor
Description Creates a new IndexMode instance.
Parameters
  • index - The Index that contains the mode.
Returns
  • The new IndexMode instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexMode.lua line 47

# Fields

# captions

Signature cp.apple.finalcutpro.timeline.IndexMode.captions <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Captions" mode.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexMode.lua line 120

# clips

Signature cp.apple.finalcutpro.timeline.IndexMode.clips <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Clips" mode.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexMode.lua line 66

# roles

Signature cp.apple.finalcutpro.timeline.IndexMode.roles <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Roles" mode.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexMode.lua line 102

# tags

Signature cp.apple.finalcutpro.timeline.IndexMode.tags <cp.ui.RadioButton>
Type Field
Description The RadioButton for the "Tags" mode.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexMode.lua line 84