GeneratorsBrowser

Last updated 23 days ago

Generators Browser Module.

API Overview

API Documentation

Constants

TITLE

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser.TITLE -> string

Type

Constant

Description

Titles & Generators Title.

Variables

isShowing

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser.isShowing <cp.prop: boolean>

Type

Variable

Description

Is the Generators Browser showing?

Constructors

new

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser.new(parent) -> GeneratorsBrowser

Type

Constructor

Description

Creates a new GeneratorsBrowser instance.

Parameters

Returns

Methods

app

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:app() -> App

Type

Method

Description

Returns the app instance representing Final Cut Pro.

Parameters

Returns

applyItem

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:applyItem(itemUI) -> GeneratorsBrowser

Type

Method

Description

Applies an item by double clicking on it.

Parameters

Returns

contents

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:contents() -> ScrollArea

Type

Method

Description

Gets the Generators Browser Contents.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:currentItemsUI() -> axuielementObject

Type

Method

Description

Gets the current items UI.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:getCurrentTitles() -> table

Type

Method

Description

Returns the list of titles for all generators currently visible.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:getGeneratorsRowLabel() -> string

Type

Method

Description

Gets a Generators Row Label.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:getTitlesRowLabel() -> string

Type

Method

Description

Returns the label of the 'Titles' row in the current language.

Parameters

Returns

group

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:group() -> PopUpButton

Type

Method

Description

Gets the group.

Parameters

Returns

hide

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:hide() -> GeneratorsBrowser

Type

Method

Description

Hides the Generators Browser.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:itemIsSelected(itemUI) -> boolean

Type

Method

Description

Checks to see if an item is selected.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:loadLayout(layout) -> none

Type

Method

Description

Loads a Generators Browser layout.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:mainGroupUI() -> axuielementObject

Type

Method

Description

Main Group UI.

Parameters

Returns

parent

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:parent() -> parent

Type

Method

Description

Returns the parent object.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:saveLayout() -> table

Type

Method

Description

Saves the current Generators Browser layout to a table.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:search() -> PopUpButton

Type

Method

Description

Gets the Search Popup Button object.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:selectedItemsUI() -> axuielementObject

Type

Method

Description

Gets the selected items UI.

Parameters

Returns

show

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:show() -> GeneratorsBrowser

Type

Method

Description

Shows the Generators Browser.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:showAllGenerators() -> GeneratorsBrowser

Type

Method

Description

Show All Generators.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:showAllTitles() -> GeneratorsBrowser

Type

Method

Description

Ensures the sidebar is showing in the Generators & Titles panel, focused on all 'Titles'.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:showGeneratorsCategory(name) -> GeneratorsBrowser

Type

Method

Description

Show a specific Generators Category.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:showInstalledGenerators() -> GeneratorsBrowser

Type

Method

Description

Ensures that the browser is showing 'Installed Generators'.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:showInstalledTitles() -> GeneratorsBrowser

Type

Method

Description

Ensures that the browser is showing 'Installed Titles'.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:showSidebar() -> GeneratorsBrowser

Type

Method

Description

Ensures the sidebar is showing in the Generators & Titles panel.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:showTitlesCategory(name) -> self

Type

Method

Description

Ensures the sidebar is showing and that the selected 'Titles' category is selected, if available.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:sidebar() -> Table

Type

Method

Description

Gets the sidebar object.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:topCategoriesUI() -> table

Type

Method

Description

Returns an array of the top-level categories in the sidebar.

Parameters

Returns

UI

Signature

cp.apple.finalcutpro.main.GeneratorsBrowser:UI() -> axuielementObject

Type

Method

Description

Gets the Generator Browser UI.

Parameters

Returns