31 lines (23 loc) · 2.37 KB

docs » cp.apple.finalcutpro.cmd.CommandEditor

Command Editor Module.

API Overview

Fields - Variables which can only be accessed from an object returned by a constructor
isShowing
Methods - API calls which can only be made on an object returned by a constructor
watch

API Documentation

Fields

isShowing

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

Methods

watch

Signature	`cp.apple.finalcutpro.cmd.CommandEditor:watch() -> bool`
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	An ID which can be passed to `unwatch` to stop watching.