#cp.apple.finalcutpro.timeline.ToolPalette

Represents the Tool Palette Menu Button in the Timeline.

Extends:


#API Overview

Constants - Useful values which cannot be changed

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


#API Documentation

#Constants

Signaturecp.apple.finalcutpro.timeline.ToolPalette.OPTIONS <table of tables>
TypeConstant
DescriptionThe options for the Tool Palette Menu Button.
Notes
  • Contains SELECT, TRIM, POSITION, RANGE, BLADE, ZOOM, and HAND.
  • The CommandSetID value can be used with cp.apple.finalcutpro:doShortcut().
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 21

#Fields

Signaturecp.apple.finalcutpro.timeline.ToolPalette.isBlade <cp.prop: boolean>
TypeField
DescriptionA cp.prop that indicates if the Tool Palette is set to the BLADE option.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 190

Signaturecp.apple.finalcutpro.timeline.ToolPalette.isHand <cp.prop: boolean>
TypeField
DescriptionA cp.prop that indicates if the Tool Palette is set to the HAND option.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 222

Signaturecp.apple.finalcutpro.timeline.ToolPalette.isPosition <cp.prop: boolean>
TypeField
DescriptionA cp.prop that indicates if the Tool Palette is set to the POSITION option.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 158

Signaturecp.apple.finalcutpro.timeline.ToolPalette.isRange <cp.prop: boolean>
TypeField
DescriptionA cp.prop that indicates if the Tool Palette is set to the RANGE option.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 174

Signaturecp.apple.finalcutpro.timeline.ToolPalette.isSelect <cp.prop: boolean>
TypeField
DescriptionA cp.prop that indicates if the Tool Palette is set to the SELECT option.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 126

Signaturecp.apple.finalcutpro.timeline.ToolPalette.isTrim <cp.prop: boolean>
TypeField
DescriptionA cp.prop that indicates if the Tool Palette is set to the TRIM option.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 142

Signaturecp.apple.finalcutpro.timeline.ToolPalette.isZoom <cp.prop: boolean>
TypeField
DescriptionA cp.prop that indicates if the Tool Palette is set to the ZOOM option.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 206

Signaturecp.apple.finalcutpro.timeline.ToolPalette.value <cp.prop: ToolPalette.OPTIONS, live?, read-write>
TypeField
DescriptionA cp.prop containing the current OPTIONS value of the Tool Palette. May be nil if the toolbar is not available.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 85