docs » cp.apple.finalcutpro.cmd.CommandEditor


Command Editor Module.

API Overview

API Documentation

Functions

matches

Signature cp.apple.finalcutpro.cmd.CommandEditor.matches(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An `axuielementObject` to check.
Returns
  • `true` if matches otherwise `false`

new

Signature cp.apple.finalcutpro.cmd.CommandEditor:new(app) -> CommandEditor
Type Function
Description Creates a new Command Editor object.
Parameters
  • app - The `cp.apple.finalcutpro` object.
Returns
  • A new CommandEditor object.

Fields

isShowing

Signature cp.apple.finalcutpro.cmd.CommandEditor.isShowing <cp.prop: boolean; read-only>
Type Field
Description Is the Command Editor showing?

Methods

app

Signature cp.apple.finalcutpro.cmd.CommandEditor:app() -> App
Type Method
Description Returns the app instance representing Final Cut Pro.
Parameters
  • None
Returns
  • App

getTitle

Signature `cp.apple.finalcutpro.cmd.CommandEditor:getTitle() -> string nil` </span>
Type Method
Description The title of the Command Editor window or nil.
Parameters
  • None
Returns
  • The title of the Command Editor window as a string or `nil`.

hide

Signature cp.apple.finalcutpro.cmd.CommandEditor:hide() -> cp.apple.finalcutpro.cmd.CommandEditor
Type Method
Description Hides the Command Editor.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.cmd.CommandEditor` object for method chaining.

save

Signature cp.apple.finalcutpro.cmd.CommandEditor:save() -> cp.apple.finalcutpro.cmd.CommandEditor
Type Method
Description Triggers the Save button in the Command Editor.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.cmd.CommandEditor` object for method chaining.

saveButton

Signature `cp.apple.finalcutpro.cmd.CommandEditor:saveButton() -> axuielementObject nil` </span>
Type Method
Description Gets the Command Editor Save Button AX item.
Parameters
  • None
Returns
  • The `axuielementObject` of the Save Button or nil.

show

Signature cp.apple.finalcutpro.cmd.CommandEditor:show() -> cp.apple.finalcutpro.cmd.CommandEditor
Type Method
Description Shows the Command Editor.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.cmd.CommandEditor` object for method chaining.

UI

Signature cp.apple.finalcutpro.cmd.CommandEditor:UI() -> axuielementObject
Type Method
Description Returns the Command Editor Accessibility Object
Parameters
  • None
Returns
  • An `axuielementObject` or `nil`

unwatch

Signature cp.apple.finalcutpro.cmd.CommandEditor:unwatch(id) -> none
Type Method
Description Unwatches an event.
Parameters
  • id - An ID as a string of the event you want to unwatch.
Returns
  • None

watch

Signature cp.apple.finalcutpro.cmd.CommandEditor:watch() -> table
Type Method
Description Watch for events that happen in the command editor. The optional functions will be called when the window is shown or hidden, respectively.
Parameters
  • `events` - A table of functions with to watch. These may be:
  • `open(window)` - Triggered when the window is shown.
  • `close(window)` - Triggered when the window is hidden.
  • `move(window)` - Triggered when the window is moved.
Returns
  • A table which contains an ID which can be passed to `unwatch` to stop watching.

results matching ""

    No results matching ""