#cp.apple.finalcutpro.main.KeywordEditor

Keyword Editor Module.

#API Overview

Constants - Useful values which cannot be changed

Functions - API calls offered directly by the extension

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

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.main.KeywordEditor.NUMBER_OF_SHORTCUTS -> number`
Type	Constant
Description	The number of Keyword Keyboard shortcuts available.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 26


Signature	`cp.apple.finalcutpro.main.KeywordEditor.matches(element) -> boolean`
Type	Function
Description	Checks to see if an `hs.axuielement` object matches a Keyword Editor window
Parameters	element - the `hs.axuielement` object you want to check
Returns	`true` if a match otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 31


Signature	`cp.apple.finalcutpro.main.KeywordEditor(parent) -> KeywordEditor object`
Type	Constructor
Description	Creates a new KeywordEditor object
Parameters	`parent` - The parent
Returns	A KeywordEditor object
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 64


Signature	`cp.apple.finalcutpro.main.KeywordEditor.isShowing <cp.prop: boolean; live?>`
Type	Field
Description	Indicates whether or not the Keyword Editor is currently showing.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 112


Signature	`cp.apple.finalcutpro.main.KeywordEditor.keyboardShortcuts <cp.ui.DisclosureWindow>`
Type	Field
Description	The `DisclosureTriangle` that shows/hides the keyboard shortcuts configuration.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 183


Signature	`cp.apple.finalcutpro.main.KeywordEditor.keywords <cp.ui.TextField>`
Type	Field
Description	A `TextField` that contains the current keywords. The value is a `table` of `string` values for each individual keyword.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 173


Signature	`cp.apple.finalcutpro.main.KeywordEditor.resetButton <cp.ui.Button>`
Type	Field
Description	The `Button` that resets the current keywords to blank.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 238


Signature	`cp.apple.finalcutpro.main.KeywordEditor.shortcutButtons <table of cp.ui.Button>`
Type	Field
Description	The list of keyboard shortcut `Button`s. The button for `Cmd+1` is accessed via `shortcutButtons[1]`, and so on.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 218


Signature	`cp.apple.finalcutpro.main.KeywordEditor.shortcutFields <table of KeywordField>`
Type	Field
Description	The list of keyboard shortcut `KeywordField`s. The field for `Cmd+1` is accessed via `shortcutFields[1]`, and so on.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 198


Signature	`cp.apple.finalcutpro.main.KeywordEditor:doHide() -> cp.rx.go.Statement`
Type	Method
Description	A `Statement` that hides the Keyword Editor.
Parameters	None
Returns	The `Statement`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 160


Signature	`cp.apple.finalcutpro.main.KeywordEditor:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A `Statement` that shows the Keyword Editor.
Parameters	None
Returns	The `Statement`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 133


Signature	`cp.apple.finalcutpro.main.KeywordEditor:hide() -> boolean`
Type	Method
Description	Hides the Keyword Editor.
Parameters	None
Returns	KeywordEditor object `true` if successful otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 146


Signature	`cp.apple.finalcutpro.main.KeywordEditor:parent() -> table`
Type	Method
Description	Returns the KeywordEditor's parent table
Parameters	None
Returns	The parent object as a table
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 89


Signature	`cp.apple.finalcutpro.main.KeywordEditor:show() -> boolean`
Type	Method
Description	Shows the Keyword Editor.
Parameters	None
Returns	KeywordEditor object `true` if successful otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordEditor.lua line 119