docs » cp.apple.finalcutpro.export.ExportDialog


Export Dialog Module.

API Overview

API Documentation

Functions

matches

Signature cp.apple.finalcutpro.export.ExportDialog.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.export.ExportDialog:new(app) -> ExportDialog
Type Function
Description Creates a new Export Dialog object.
Parameters
  • app - The `cp.apple.finalcutpro` object.
Returns
  • A new ExportDialog object.

Fields

isShowing

Signature cp.apple.finalcutpro.export.ExportDialog.isShowing <cp.prop: boolean; read-only>
Type Field
Description Is the window showing?

Methods

app

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

getTitle

Signature `cp.apple.finalcutpro.export.ExportDialog:getTitle() -> string nil` </span>
Type Method
Description The title of the Go To Prompt window or nil.
Parameters
  • None
Returns
  • The title of the Go To Prompt window as a string or `nil`.

hide

Signature cp.apple.finalcutpro.export.ExportDialog:hide() -> cp.apple.finalcutpro.export.ExportDialog
Type Method
Description Hides the Export Dialog
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.export.ExportDialog` object for method chaining.

pressCancel

Signature cp.apple.finalcutpro.export.ExportDialog:pressCancel() -> cp.apple.finalcutpro.export.ExportDialog
Type Method
Description Presses the Cancel Button.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.export.ExportDialog` object for method chaining.

pressNext

Signature cp.apple.finalcutpro.export.ExportDialog:pressNext() -> cp.apple.finalcutpro.export.ExportDialog
Type Method
Description Presses the Next Button.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.export.ExportDialog` object for method chaining.

saveSheet

Signature cp.apple.finalcutpro.export.ExportDialog:saveSheet() -> SaveSheet
Type Method
Description Creates a new Save Sheet.
Parameters
  • None
Returns
  • The SaveSheet.

show

Signature cp.apple.finalcutpro.export.ExportDialog:show() -> cp.apple.finalcutpro.export.ExportDialog
Type Method
Description Shows the Export Dialog
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.export.ExportDialog` object for method chaining.

UI

Signature cp.apple.finalcutpro.export.ExportDialog:UI() -> axuielementObject
Type Method
Description Returns the Export Dialog Accessibility Object
Parameters
  • None
Returns
  • An `axuielementObject` or `nil`

unwatch

Signature cp.apple.finalcutpro.export.ExportDialog: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.export.ExportDialog: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:
  • `show(CommandEditor)` - Triggered when the window is shown.
  • `hide(CommandEditor)` - Triggered when the window is hidden.
Returns
  • An ID which can be passed to `unwatch` to stop watching.

results matching ""

    No results matching ""