#cp.apple.finalcutpro.main.KeywordField

Keyword Text Field Module.

#API Overview

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

KeywordField

Methods - API calls which can only be made on an object returned by a constructor

addKeyword
removeKeyword

#API Documentation

#Constructors

#KeywordField


Signature	`cp.apple.finalcutpro.main.KeywordField(parent, uiFinder) -> KeywordField`
Type	Constructor
Description	Constructs a new KeywordField.
Parameters	parent - the parent object. uiFinder - The `function` or `cp.prop` that provides the axuielement.
Returns	The new `KeywordField`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordField.lua line 17

#Methods

#addKeyword


Signature	`cp.apple.finalcutpro.main.KeywordField:addKeyword(keyword) -> boolean`
Type	Method
Description	Attempts to add the specified keyword.
Parameters	keyword - The keyword string to add.
Returns	`true` if the keyword was not present and added, otherwise false.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordField.lua line 53

#removeKeyword


Signature	`cp.apple.finalcutpro.main.KeywordField:removeKeyword(keyword) -> boolean`
Type	Method
Description	Attempts to remove the specified keyword.
Parameters	keyword - The keyword string to remove.
Returns	`true` if the keyword was present and removed, otherwise false.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/KeywordField.lua line 77