#cp.apple.finalcutpro.inspector.text.TextInspector

Text Inspector Module.

Section Rows (compositing, transform, etc.) have the following properties:

  • enabled - (cp.ui.CheckBox) Indicates if the section is enabled.
  • toggle - (cp.ui.Button) Will toggle the Hide/Show button.
  • reset - (cp.ui.Button) Will reset the contents of the section.
  • expanded - (cp.prop ) Get/sets whether the section is expanded.

Property Rows depend on the type of property:

Menu Property:

  • value - (cp.ui.PopUpButton) The current value of the property.

Slider Property:

  • value - (cp.ui.Slider) The current value of the property.

XY Property:

  • x - (cp.ui.TextField) The current 'X' value.
  • y - (cp.ui.TextField) The current 'Y' value.

CheckBox Property:

  • value - (cp.ui.CheckBox) The currently value.

For example:

local text = fcp.inspector.text -- Menu Property: text:compositing():blendMode():value("Subtract") -- Slider Property: text:compositing():opacity():value(50.0) -- XY Property: text:transform():position():x(-10.0) -- CheckBox property: text:stabilization():tripodMode():value(true)

You should also be able to show a specific property and it will be revealed:

text:stabilization():smoothing():show():value(1.5)

#API Overview

Functions - API calls offered directly by the extension

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

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


#API Documentation

#Functions

Signaturecp.apple.finalcutpro.inspector.text.TextInspector.matches(element)
TypeFunction
DescriptionChecks if the provided element could be a TextInspector.
Parameters
  • element - The element to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 85

#Constructors

Signaturecp.apple.finalcutpro.inspector.text.TextInspector(parent) -> cp.apple.finalcutpro.text.TextInspector
TypeConstructor
DescriptionCreates a new TextInspector object
Parameters
  • parent - The parent
Returns
  • A TextInspector object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 100

#Methods

Signaturecp.apple.finalcutpro.inspector.text.TextInspector:doHide() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that hides the Text Inspector.
Parameters
  • None
Returns
  • The Statement to execute.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 534

Signaturecp.apple.finalcutpro.inspector.text.TextInspector:doShow() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that shows the Text Inspector.
Parameters
  • None
Returns
  • The Statement to execute.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 520

Signaturecp.apple.finalcutpro.inspector.text.TextInspector:show() -> TextInspector
TypeMethod
DescriptionShows the Text Inspector
Parameters
  • None
Returns
  • TextInspector
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 504