#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

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


#API Documentation

#Constructors

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText(cpApp)
TypeConstructor
DescriptionCreates a new "Find and Replace Title Text" Dialog
Parameters
  • cpApp - The cpApp
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 37

#Fields

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.findText <cp.ui.TextField>
TypeField
DescriptionThe "Find" search field, as a TextField
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 54

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.loopSearch <cp.ui.CheckBox>
TypeField
DescriptionThe "Loop search" CheckBox.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 109

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.matchCase <cp.ui.CheckBox>
TypeField
DescriptionThe "Match case" CheckBox.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 87

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.next <cp.ui.Button>
TypeField
DescriptionThe "Next" Button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 164

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.previous <cp.ui.Button>
TypeField
DescriptionThe "Previous" Button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 153

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.replace <cp.ui.Button>
TypeField
DescriptionThe "Replace" Button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 131

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.replaceAll <cp.ui.Button>
TypeField
DescriptionThe "Replace All" Button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 120

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.replaceAndFind <cp.ui.Button>
TypeField
DescriptionThe "Replace & Find" Button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 142

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.replaceText <cp.ui.TextField>
TypeField
DescriptionThe "Replace" search field, as a TextField
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 65

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.searchIn <cp.ui.PopUpButton>
TypeField
DescriptionThe "Search In" PopUpButton.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 76

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText.wholeWords <cp.ui.CheckBox>
TypeField
DescriptionThe "Whole words" CheckBox.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 98

#Methods

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText:doFindAndReplaceAll(find, replace) -> cp.rx.go.Statement
TypeMethod
DescriptionA 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
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 248

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText:doHide() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that will attempt to hide the "Find And Replace Title Text" dialog.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 192

Signaturecp.apple.finalcutpro.main.FindAndReplaceTitleText:doShow() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that will attempt to show the "Find And Replace Title Text" dialog.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/FindAndReplaceTitleText.lua line 175