cp.apple.finalcutpro.main.FindAndReplaceTitleText

Represents a "Find and Replace Title Text" dialogue box.

API Overview

Constructors - API calls which return an object, typically one that offers API methods

FindAndReplaceTitleText

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

findText
loopSearch
matchCase
next
previous
replace
replaceAll
replaceAndFind
replaceText
searchIn
wholeWords

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

doFindAndReplaceAll
doHide
doShow

API Documentation

Constructors

FindAndReplaceTitleText


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText(cpApp)`
Type	Constructor
Description	Creates a new "Find and Replace Title Text" Dialog
Parameters	cpApp - The cpApp
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 37

Fields

findText


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.findText <cp.ui.TextField>`
Type	Field
Description	The "Find" search field, as a TextField
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 54

loopSearch


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.loopSearch <cp.ui.CheckBox>`
Type	Field
Description	The "Loop search" CheckBox.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 109

matchCase


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.matchCase <cp.ui.CheckBox>`
Type	Field
Description	The "Match case" CheckBox.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 87


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.next <cp.ui.Button>`
Type	Field
Description	The "Next" Button.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 164


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.previous <cp.ui.Button>`
Type	Field
Description	The "Previous" Button.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 153

replace


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.replace <cp.ui.Button>`
Type	Field
Description	The "Replace" Button.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 131

replaceAll


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.replaceAll <cp.ui.Button>`
Type	Field
Description	The "Replace All" Button.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 120

replaceAndFind


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.replaceAndFind <cp.ui.Button>`
Type	Field
Description	The "Replace & Find" Button.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 142

replaceText


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.replaceText <cp.ui.TextField>`
Type	Field
Description	The "Replace" search field, as a TextField
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 65

searchIn


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.searchIn <cp.ui.PopUpButton>`
Type	Field
Description	The "Search In" PopUpButton.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 76

wholeWords


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText.wholeWords <cp.ui.CheckBox>`
Type	Field
Description	The "Whole words" CheckBox.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 98

Methods

doFindAndReplaceAll


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText:doFindAndReplaceAll(find, replace) -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will attempt to find all titles containing `find` and replace them with `replace`.
Parameters	find - what to find replace - what to replace
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 248

doHide


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText:doHide() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will attempt to hide the "Find And Replace Title Text" dialog.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 192

doShow


Signature	`cp.apple.finalcutpro.main.FindAndReplaceTitleText:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will attempt to show the "Find And Replace Title Text" dialog.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 175