#cp.apple.finalcutpro.inspector.color.CorrectionsBar

The Correction selection/management bar at the top of the ColorInspector.

Requires Final Cut Pro 10.4 or later.

Color Adjustments requires Final Cut Pro 10.6.6 or later.

#API Overview

Functions - API calls offered directly by the extension

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


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar(parent) -> CorrectionsBar`
Type	Function
Description	Creates a new Media Import object.
Parameters	parent - The parent object.
Returns	A new CorrectionsBar object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 70


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar.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/inspector/color/CorrectionsBar.lua line 47


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar.correction <cp.ui.MenuButton>`
Type	Field
Description	The `MenuButton` that lists the current correction.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 98


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar.menuButton <MenuButton>`
Type	Field
Description	The menu button.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 135


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar:activate(correctionType, number) -> cp.apple.finalcutpro.inspector.color.CorrectionsBar`
Type	Method
Description	Activates a correction type.
Parameters	`correctionType` - The correction type as string. `number` - The number of the correction.
Returns	`cp.apple.finalcutpro.inspector.color.CorrectionsBar` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 162


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar:add(correctionType) -> cp.apple.finalcutpro.inspector.color.CorrectionsBar`
Type	Method
Description	Adds the specific correction type.
Parameters	`correctionType` - The correction type as string.
Returns	`cp.apple.finalcutpro.inspector.color.CorrectionsBar` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 241


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar:doActivate(correctionType, number) -> cp.rx.go.Statement`
Type	Method
Description	A Statement that activates a correction type.
Parameters	`correctionType` - The correction type as string. `number` - The number of the correction.
Returns	The `Statement`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 212


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will attempt to show the bar.
Parameters	None
Returns	The `Statement`, which will resolve to `true` if successful, or send an `error` if not.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 122


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar:findCorrectionLabel(correctionType) -> string`
Type	Method
Description	Returns Correction Label.
Parameters	correctionType - The correction type as string.
Returns	The correction label as string.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 144


Signature	`cp.apple.finalcutpro.inspector.color.CorrectionsBar:show() -> self`
Type	Method
Description	Attempts to show the bar.
Parameters	None
Returns	The `CorrectionsBar` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 107