#cp.apple.finalcutpro.main.GeneratorsBrowser

Generators Browser Module.

#API Overview

Constants - Useful values which cannot be changed

TITLE

Variables - Configurable values

isShowing

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

GeneratorsBrowser

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

contents
group
mainGroupUI
search
sidebar

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

applyItem
currentItemsUI
getCurrentTitles
getGeneratorsRowLabel
getTitlesRowLabel
hide
itemIsSelected
loadLayout
saveLayout
selectedItemsUI
show
showAllGenerators
showAllTitles
showGeneratorsCategory
showInstalledGenerators
showInstalledTitles
showSidebar
showTitlesCategory
topCategoriesUI

#API Documentation

#Constants

#TITLE


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser.TITLE -> string`
Type	Constant
Description	Titles & Generators Title.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 37

#Variables

#isShowing


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser.isShowing <cp.prop: boolean>`
Type	Variable
Description	Is the Generators Browser showing?
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 68

#Constructors

#GeneratorsBrowser


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser(parent) -> GeneratorsBrowser`
Type	Constructor
Description	Creates a new `GeneratorsBrowser` instance.
Parameters	app - The `cp.apple.finalcutpro` object.
Returns	A new `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 42

#Fields

#contents


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser.contents <cp.ui.ScrollArea>`
Type	Field
Description	The Generators Browser Contents.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 152

#group


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser.group <cp.ui.PopUpButton>`
Type	Field
Description	The group.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 164

#mainGroupUI


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser.mainGroupUI <cp.prop: axuielementObject>`
Type	Field
Description	Main Group UI.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 130

#search


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser.search <cp.ui.TextField>`
Type	Field
Description	Gets the Search TextField object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 173


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser.sidebar <cp.ui.OldTable>`
Type	Field
Description	The sidebar object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 143

#Methods

#applyItem


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:applyItem(itemUI) -> GeneratorsBrowser`
Type	Method
Description	Applies an item by double clicking on it.
Parameters	itemUI - The `axuielementObject` of the item you want to apply.
Returns	The `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 380

#currentItemsUI


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:currentItemsUI() -> axuielementObject`
Type	Method
Description	Gets the current items UI.
Parameters	None
Returns	`axuielementObject` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 333

#getCurrentTitles


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:getCurrentTitles() -> table`
Type	Method
Description	Returns the list of titles for all generators currently visible.
Parameters	None
Returns	A table
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 399

#getGeneratorsRowLabel


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:getGeneratorsRowLabel() -> string`
Type	Method
Description	Gets a Generators Row Label.
Parameters	None
Returns	The Generators Row Label as string.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 287

#getTitlesRowLabel


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:getTitlesRowLabel() -> string`
Type	Method
Description	Returns the label of the 'Titles' row in the current language.
Parameters	None
Returns	The 'Titles' label.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 241

#hide


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:hide() -> GeneratorsBrowser`
Type	Method
Description	Hides the Generators Browser.
Parameters	None
Returns	The `GeneratorsBrowser` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 105

#itemIsSelected


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:itemIsSelected(itemUI) -> boolean`
Type	Method
Description	Checks to see if an item is selected.
Parameters	itemUI - A `axuielementObject` to check.
Returns	`true` if the item is selected, otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 359

#loadLayout


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:loadLayout(layout) -> none`
Type	Method
Description	Loads a Generators Browser layout.
Parameters	layout - A table containing the Generators Browser layout settings - created using `cp.apple.finalcutpro.main.GeneratorsBrowser:saveLayout()`.
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 444

#saveLayout


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:saveLayout() -> table`
Type	Method
Description	Saves the current Generators Browser layout to a table.
Parameters	None
Returns	A table containing the current Effects Browser Layout.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 424

#selectedItemsUI


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:selectedItemsUI() -> axuielementObject`
Type	Method
Description	Gets the selected items UI.
Parameters	None
Returns	`axuielementObject` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 346

#show


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:show() -> GeneratorsBrowser`
Type	Method
Description	Shows the Generators Browser.
Parameters	None
Returns	The `GeneratorsBrowser` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 78

#showAllGenerators


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:showAllGenerators() -> GeneratorsBrowser`
Type	Method
Description	Show All Generators.
Parameters	None
Returns	The `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 300

#showAllTitles


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	None
Returns	The `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 254

#showGeneratorsCategory


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:showGeneratorsCategory(name) -> GeneratorsBrowser`
Type	Method
Description	Show a specific Generators Category.
Parameters	name - The name of the Generators Category to show.
Returns	The `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 318

#showInstalledGenerators


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:showInstalledGenerators() -> GeneratorsBrowser`
Type	Method
Description	Ensures that the browser is showing 'Installed Generators'.
Parameters	None
Returns	The `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 227

#showInstalledTitles


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:showInstalledTitles() -> GeneratorsBrowser`
Type	Method
Description	Ensures that the browser is showing 'Installed Titles'.
Parameters	None
Returns	The `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 213

#showSidebar


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:showSidebar() -> GeneratorsBrowser`
Type	Method
Description	Ensures the sidebar is showing in the Generators & Titles panel.
Parameters	None
Returns	The `GeneratorsBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 182

#showTitlesCategory


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	name - The category name, in the current language.
Returns	The Generators Browser.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 272

#topCategoriesUI


Signature	`cp.apple.finalcutpro.main.GeneratorsBrowser:topCategoriesUI() -> table`
Type	Method
Description	Returns an array of the top-level categories in the sidebar.
Parameters	None
Returns	The array of category rows.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/GeneratorsBrowser.lua line 198