Skip to content
This repository was archived by the owner on Jun 9, 2023. It is now read-only.

cp.apple.finalcutpro.inspector.InspectorProperty.md

Latest commit

 

History

History
116 lines (99 loc) · 12 KB

cp.apple.finalcutpro.inspector.InspectorProperty.md

File metadata and controls

116 lines (99 loc) · 12 KB

docs » cp.apple.finalcutpro.inspector.InspectorProperty

InspectorProperty contains helper functions for handling common property types that occur in various Inspectors in FCP.

In addition to specific property row types like textField, slider, etc., there is also a section, which is for rows which expand/collapse to reveal other properties.

API Overview

API Documentation

Functions

checkBox

Signature cp.apple.finalcutpro.inspector.InspectorProperty.checkBox(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

hasProperties

Signature cp.apple.finalcutpro.inspector.InspectorProperty.hasProperties(parent, uiFinder) -> boolean
Type Function
Description This will prepare the parent to handle containing PropertyRow children, and returns
Parameters
  • parent - The parent table.
  • uiFinder - The function or cp.prop which will be called to find the parent UI element. Functions will be passed the parent when being executed.
Returns

menuButton

Signature cp.apple.finalcutpro.inspector.InspectorProperty.menuButton(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

numberField

Signature cp.apple.finalcutpro.inspector.InspectorProperty.numberField(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

popUpButton

Signature cp.apple.finalcutpro.inspector.InspectorProperty.popUpButton(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

section

Signature cp.apple.finalcutpro.inspector.InspectorProperty.section(labelKey[, index]) -> function
Type Function
Description Returns a 'section row' factory function that can be called to create a section row that contains other PropertyRow' cp.prop`s.
Parameters
  • labelKey - The I18N lookup key to find the row with.
  • index - (optional) The occurrence of the key value in the parent. Sometimes multiple rows have the same title. Defaults to 1.
Returns
  • A function which will create the section row when called.

simple

Signature cp.apple.finalcutpro.inspector.InspectorProperty.simple(labelKey[, prepareFn][, index]]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • prepareFn - The function to call to perform additional preparations on the row.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

slider

Signature cp.apple.finalcutpro.inspector.InspectorProperty.slider(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

staticText

Signature cp.apple.finalcutpro.inspector.InspectorProperty.staticText(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

textField

Signature cp.apple.finalcutpro.inspector.InspectorProperty.textField(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.

xy

Signature cp.apple.finalcutpro.inspector.InspectorProperty.xy(labelKey[, index]) -> cp.prop <cp.ui.PropertyRow; read-only>
Type Function
Description Creates a new cp.prop that contains a PropertyRow matching the labelKey.
Parameters
  • labelKey - The I18N key that the row lable matches.
  • index - The instance number of that label (defaults to 1).
Returns
  • The cp.prop that returns the PropertyRow.