# cp.apple.finalcutpro.timeline.ToolPalette

Represents the Tool Palette Menu Button in the Timeline.

Extends:

MenuButton

# API Overview

Constants - Useful values which cannot be changed

OPTIONS

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

isBlade
isHand
isPosition
isRange
isSelect
isTrim
isZoom
value

# API Documentation

# Constants

# OPTIONS


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.OPTIONS <table of tables>`
Type	Constant
Description	The 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()`.
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 21

# Fields

# isBlade


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.isBlade <cp.prop: boolean>`
Type	Field
Description	A `cp.prop` that indicates if the Tool Palette is set to the `BLADE` option.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 190

# isHand


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.isHand <cp.prop: boolean>`
Type	Field
Description	A `cp.prop` that indicates if the Tool Palette is set to the `HAND` option.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 222

# isPosition


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.isPosition <cp.prop: boolean>`
Type	Field
Description	A `cp.prop` that indicates if the Tool Palette is set to the `POSITION` option.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 158

# isRange


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.isRange <cp.prop: boolean>`
Type	Field
Description	A `cp.prop` that indicates if the Tool Palette is set to the `RANGE` option.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 174

# isSelect


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.isSelect <cp.prop: boolean>`
Type	Field
Description	A `cp.prop` that indicates if the Tool Palette is set to the `SELECT` option.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 126

# isTrim


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.isTrim <cp.prop: boolean>`
Type	Field
Description	A `cp.prop` that indicates if the Tool Palette is set to the `TRIM` option.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 142

# isZoom


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.isZoom <cp.prop: boolean>`
Type	Field
Description	A `cp.prop` that indicates if the Tool Palette is set to the `ZOOM` option.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 206

# value


Signature	`cp.apple.finalcutpro.timeline.ToolPalette.value <cp.prop: ToolPalette.OPTIONS, live?, read-write>`
Type	Field
Description	A `cp.prop` containing the current OPTIONS value of the Tool Palette. May be `nil` if the toolbar is not available.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/ToolPalette.lua line 85