docs » cp.apple.finalcutpro.main.KeywordEditor


Keyword Editor Module.

Submodules

API Overview

API Documentation

Functions

matches

Signature cp.apple.finalcutpro.main.KeywordEditor.matches(element) -> boolean
Type Function
Description Checks to see if an hs._asm.axuielement object matches a Keyword Editor window
Parameters
  • element - the `hs._asm.axuielement` object you want to check
Returns
  • `true` if a match otherwise `false`

Methods

app

Signature cp.apple.finalcutpro.main.KeywordEditor:app() -> table
Type Method
Description Returns the cp.apple.finalcutpro app table
Parameters
  • None
Returns
  • The application object as a table

hide

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`

isShowing

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

keyword

Signature `cp.apple.finalcutpro.main.KeywordEditor:keyword(value) -> string table nil` </span>
Type Method
Description Sets or gets the main Keyword Textbox value.
Parameters
  • 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:new(parent) -> KeywordEditor object
Type Method
Description Creates a new KeywordEditor object
Parameters
  • `parent` - The parent
Returns
  • A KeywordEditor object

parent

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

removeKeyword

Signature cp.apple.finalcutpro.main.KeywordEditor:removeKeyword(keyword) -> boolean
Type Method
Description Removes a keyword from the main Keyword Textbox.
Parameters
  • keyword - The keyword you want to remove as a string.
Returns
  • `true` if successful otherwise `false`

show

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`

toolbarCheckBoxUI

Signature cp.apple.finalcutpro.main.KeywordEditor:toolbarCheckBoxUI() -> hs._asm.axuielement object
Type Method
Description Returns the hs._asm.axuielement object for the Keyword Editor button in the toolbar
Parameters
  • None
Returns
  • A `hs._asm.axuielement` object

UI

Signature cp.apple.finalcutpro.main.KeywordEditor:UI() -> hs._asm.axuielement object
Type Method
Description Returns the hs._asm.axuielement object for the Keyword Editor window
Parameters
  • None
Returns
  • A `hs._asm.axuielement` object

results matching ""

    No results matching ""