#cp.apple.finalcutpro.export.GoToPrompt

Go To Prompt.

#API Overview

Functions - API calls offered directly by the extension

Fields - Variables which can only be accessed from an object returned by a constructor

Methods - API calls which can only be made on an object returned by a constructor


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`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 26


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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 43


Signature	`cp.apple.finalcutpro.export.GoToPrompt.cancel <cp.ui.Button>`
Type	Field
Description	The "Cancel" `Button`.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 96


Signature	`cp.apple.finalcutpro.export.GoToPrompt.go <cp.ui.Button>`
Type	Field
Description	The "Go" `Button`.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 105


Signature	`cp.apple.finalcutpro.export.GoToPrompt.valueCombo <cp.ui.ComboBox>`
Type	Field
Description	The `ComboBox` containing the folder value, if available.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 128


Signature	`cp.apple.finalcutpro.export.GoToPrompt.valueText <cp.ui.TextField>`
Type	Field
Description	The `TextField` containing the folder value, if available.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 119


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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 83


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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 172


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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 63


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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 159


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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/export/GoToPrompt.lua line 142