cp.apple.finalcutpro.export.GoToPrompt.md

docs » cp.apple.finalcutpro.export.GoToPrompt

---

Go To Prompt.

API Overview

• Functions - API calls offered directly by the extension
• matches
• new
• Fields - Variables which can only be accessed from an object returned by a constructor
• cancel
• go
• valueCombo
• valueText
• Methods - API calls which can only be made on an object returned by a constructor
• hide
• setValue
• show
• value
• valueField

API Documentation

Functions

matches

Signature	cp.apple.finalcutpro.export.GoToPrompt.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.GoToPrompt.new(app) -> GoToPrompt
Type	Function
Description	Creates a new Go To Prompt object.
Parameters	app - The cp.apple.finalcutpro object.
Returns	A new GoToPrompt object.

Fields

cancel

Signature	cp.apple.finalcutpro.export.GoToPrompt.cancel <cp.ui.Button>
Type	Field
Description	The "Cancel" Button.

go

Signature	cp.apple.finalcutpro.export.GoToPrompt.go <cp.ui.Button>
Type	Field
Description	The "Go" Button.

valueCombo

Signature	cp.apple.finalcutpro.export.GoToPrompt.valueCombo <cp.ui.ComboBox>
Type	Field
Description	The ComboBox containing the folder value, if available.

valueText

Signature	cp.apple.finalcutpro.export.GoToPrompt.valueText <cp.ui.TextField>
Type	Field
Description	The TextField containing the folder value, if available.

Methods

hide

Signature	cp.apple.finalcutpro.export.GoToPrompt:hide() -> cp.apple.finalcutpro.export.GoToPrompt
Type	Method
Description	Hides the Go To Prompt
Parameters	None
Returns	The cp.apple.finalcutpro.export.GoToPrompt object for method chaining.

setValue

Signature	cp.apple.finalcutpro.export.GoToPrompt:setValue(value) -> cp.apple.finalcutpro.export.GoToPrompt
Type	Method
Description	Sets the value of the text box within the Go To Prompt.
Parameters	value - The value of the text box as a string.
Returns	The cp.apple.finalcutpro.export.GoToPrompt object for method chaining.

show

Signature	cp.apple.finalcutpro.export.GoToPrompt:show() -> cp.apple.finalcutpro.export.GoToPrompt
Type	Method
Description	Shows the Go To Prompt
Parameters	None
Returns	The cp.apple.finalcutpro.export.GoToPrompt object for method chaining.

value

Signature	cp.apple.finalcutpro.export.GoToPrompt:value([newValue]) -> string
Type	Method
Description	Returns the current path value, or nil.
Parameters	newValue - (optional) The new value for the path.
Returns	The current value of the path.

valueField

| Signature | cp.apple.finalcutpro.export.GoToPrompt:valueField() -> TextField | ComboField | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Returns either the valueText or valueCombo, depending what is available on-screen. | | Parameters |

• None

| | Returns |

• The TextField or ComboField containing the value.

|