Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
114 lines (95 loc) · 9.01 KB

cp.apple.finalcutpro.cmd.CommandEditor.md

File metadata and controls

114 lines (95 loc) · 9.01 KB
Raw

docs » cp.apple.finalcutpro.cmd.CommandEditor

Command Editor Module.

API Overview

  • Functions - API calls offered directly by the extension
  • matches
  • Constructors - API calls which return an object, typically one that offers API methods
  • CommandEditor
  • Fields - Variables which can only be accessed from an object returned by a constructor
  • close
  • save
  • UI
  • Methods - API calls which can only be made on an object returned by a constructor
  • app
  • doClose
  • doSave
  • doShow
  • hide
  • show

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

Constructors

CommandEditor

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

Fields

close

Signature cp.apple.finalcutpro.cmd.CommandEditor.close <cp.ui.Button>
Type Field
Description The "Close" Button.

save

Signature cp.apple.finalcutpro.cmd.CommandEditor.save <cp.ui.Button>
Type Field
Description The "Save" Button.

UI

Signature cp.apple.finalcutpro.cmd.CommandEditor.UI <cp.prop: axuielement; read-only>
Type Field
Description The axuielement for the window.

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

doClose

Signature cp.apple.finalcutpro.cmd.CommandEditor:doClose() -> cp.rx.go.Statement <boolean>
Type Method
Description Returns a Statement that triggers the Close button in the Command Editor.
Parameters
  • None
Returns
  • The Statement, resolving to true if the button was found and pushed, otherwise false.

doSave

Signature cp.apple.finalcutpro.cmd.CommandEditor:doSave() -> cp.rx.go.Statement <boolean>
Type Method
Description Returns a Statement that triggers the Save button in the Command Editor.
Parameters
  • None
Returns
  • The Statement, resolving to true if the button was found and pushed, otherwise false.

doShow

Signature cp.apple.finalcutpro.cmd.CommandEditor:doShow() -> cp.rx.go.Statement <boolean>
Type Method
Description Creates a Statement that will attempt to hide the Command Editor, if FCPX is running.
Parameters
  • None
Returns
  • The Statement, which will resolve to true if the CommandEditor is not showing or false if not.

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.

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.