docs » cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts


Keyboard Shortcuts

API Overview

API Documentation

Methods

apply

Signature cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:apply(item) -> boolean
Type Method
Description Applies a Keyword Shortcut.
Parameters
  • item - The textbox you want to update. This can be a number between 1 and 9.
Returns
  • `true` if successful otherwise `false`

hide

Signature cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:hide() -> boolean
Type Method
Description Hides the Keyword Editor's Keyboard Shortcuts section.
Parameters
  • None
Returns
  • `true` if successful otherwise `false`

isShowing

Signature cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:isShowing() -> boolean
Type Method
Description Gets whether or not the Keyword Editor's Keyboard Shortcuts section is currently showing.
Parameters
  • None
Returns
  • `true` if showing otherwise `false`

keyword

Signature `cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:keyword(item, value) -> string table nil` </span>
Type Method
Description Sets or gets a specific Keyboard Shortcut Keyword Textbox value.
Parameters
  • item - The textbox you want to update. This can be a number between 1 and 9.
  • value - The value you want to set the keyword textbox to. This can either be a string, with the tags separated by a comma, or a table of tags.
Returns
  • `value` if successful otherwise `false`

new

Signature cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:new(parent) -> KeyboardShortcuts object
Type Method
Description Creates a new KeyboardShortcuts object
Parameters
  • `parent` - The parent
Returns
  • A KeyboardShortcuts object

parent

Signature cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:parent() -> table
Type Method
Description Returns the KeywordShortcuts's parent table
Parameters
  • None
Returns
  • The parent object as a table

removeAllKeywords

Signature cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:removeAllKeywords() -> boolean
Type Method
Description Triggers the "Remove all Keywords" button.
Parameters
  • None
Returns
  • `true` if successful otherwise `false`

show

Signature cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts:show() -> boolean
Type Method
Description Shows the Keyword Editor's Keyboard Shortcuts section.
Parameters
  • None
Returns
  • `true` if successful otherwise `false`

results matching ""

    No results matching ""