#cp.apple.finalcutpro.timeline.Toolbar

Timeline Toolbar

#Submodules

#API Overview

Functions - API calls offered directly by the extension

matches

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

Toolbar

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

appearance
appearanceToggle
appendClip
audioSkimming
back
browser
clip
clipMedia
duration
effects
forward
index
insertClip
overwriteClip
skimming
snapping
solo
title
tool
transitions
trimAlignedEdges

#API Documentation

#Functions

#matches


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

#Constructors


Signature	`cp.apple.finalcutpro.timeline.Toolbar(timeline) -> cp.apple.finalcutpro.timeline.Toolbar`
Type	Constructor
Description	Creates a new Toolbar with the specified parent.
Parameters	timeline - The Timeline.
Returns	The new Toolbar instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 43

#Fields

#appearance


Signature	`cp.apple.finalcutpro.timeline.Toolbar.appearance <cp.apple.finalcutpro.timeline.Appearance>`
Type	Field
Description	The Appearance button/palette control.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 242

#appearanceToggle


Signature	`cp.apple.finalcutpro.timeline.Toolbar.appearanceToggle <cp.ui.CheckBox>`
Type	Field
Description	A `CheckBox` field which will toggle the `appearance` popover.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 231

#appendClip


Signature	`cp.apple.finalcutpro.timeline.Toolbar.appendClip <cp.ui.Button>`
Type	Field
Description	The Button which appends a clip from the Browser into the Timeline.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 101

#audioSkimming


Signature	`cp.apple.finalcutpro.timeline.Toolbar.audioSkimming <cp.ui.CheckBox>`
Type	Field
Description	The CheckBox that indicates if audio is played while skimming.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 219

#back


Signature	`cp.apple.finalcutpro.timeline.Toolbar.back <cp.ui.Button>`
Type	Field
Description	The Button for "go back in timeline history".
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 147

#browser


Signature	`cp.apple.finalcutpro.timeline.Toolbar.browser <cp.apple.finalcutpro.timeline.Toolbar.Browser>`
Type	Field
Description	The Toolbar.Browser containing buttons that will toggle the Effects/Transitions browsers.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 249

#clip


Signature	`cp.apple.finalcutpro.timeline.Toolbar.clip <cp.apple.finalcutpro.timeline.Toolbar.Clip>`
Type	Field
Description	The Clip group of checkbox items.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 196

#clipMedia


Signature	`cp.apple.finalcutpro.timeline.Toolbar.clipMedia <cp.ui.MenuButton>`
Type	Field
Description	The MenuButton which allows the user to select the media type that will
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 123

#duration


Signature	`cp.apple.finalcutpro.timeline.Toolbar.duration <cp.ui.StaticText>`
Type	Field
Description	The StaticText which displays the duration of the Timeline.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 171

#effects


Signature	`cp.apple.finalcutpro.timeline.Toolbar.effects <cp.ui.RadioButton>`
Type	Field
Description	The RadioButton which toggles the 'Effects' browser visibility.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 260

#forward


Signature	`cp.apple.finalcutpro.timeline.Toolbar.forward <cp.ui.Button>`
Type	Field
Description	The Button for "go forward in timeline history".
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 185

#index


Signature	`cp.apple.finalcutpro.timeline.Toolbar.index <cp.ui.CheckBox>`
Type	Field
Description	The CheckBox which indicates if the Timeline Index is visible.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 68

#insertClip


Signature	`cp.apple.finalcutpro.timeline.Toolbar.insertClip <cp.ui.Button>`
Type	Field
Description	The Button which inserts a clip from the Browser into the Timeline.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 90

#overwriteClip


Signature	`cp.apple.finalcutpro.timeline.Toolbar.overwriteClip <cp.ui.Button>`
Type	Field
Description	The Button which overwrites a clip from the Browser into the Timeline.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 112

#skimming


Signature	`cp.apple.finalcutpro.timeline.Toolbar.skimming <cp.ui.CheckBox>`
Type	Field
Description	The CheckBox that indicates if video/audio skimming is active.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 215

#snapping


Signature	`cp.apple.finalcutpro.timeline.Toolbar.snapping <cp.ui.CheckBox>`
Type	Field
Description	The CheckBox that indicates if snapping is enabled.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 227

#solo


Signature	`cp.apple.finalcutpro.timeline.Toolbar.solo <cp.ui.CheckBox>`
Type	Field
Description	The CheckBox that indicates if audio is soloed on the selected clip(s).
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 223

#title


Signature	`cp.apple.finalcutpro.timeline.Toolbar.title <cp.ui.MenuButton>`
Type	Field
Description	The MenuButton which lists the current project and allows
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 158

#tool


Signature	`cp.apple.finalcutpro.timeline.Toolbar.tool <cp.apple.finalcutpro.timeline.ToolPalette>`
Type	Field
Description	The ToolPalette, which allows the user to select the tool
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 135

#transitions


Signature	`cp.apple.finalcutpro.timeline.Toolbar.transitions <cp.ui.RadioButton>`
Type	Field
Description	The RadioButton which toggles the 'Transitions' browser visibility.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 264

#trimAlignedEdges


Signature	`cp.apple.finalcutpro.timeline.Toolbar.trimAlignedEdges <cp.ui.CheckBox>`
Type	Field
Description	The CheckBox which allows the user to trim the edges of the selected clips.
Notes	As of FCP 10.6.3, this is currently always hidden, and cannot have its value changed. Uncertain in exactly which version this turned up.
Source	src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 207