#cp.apple.finalcutpro.main.Browser

Browser Module.

#Submodules

cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover

#API Overview

Functions - API calls offered directly by the extension

matches

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

Browser

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

generators
generatorsShowing
isOnPrimary
isOnSecondary
libraries
librariesShowing
markerPopover
media
mediaShowing
showGenerators
showLibraries
showMedia

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

appearanceAndFiltering
doHide
doShow
doShowOnPrimary
doShowOnSecondary
hide
loadLayout
saveLayout
showOnPrimary
showOnSecondary

#API Documentation

#Functions

#matches


Signature	`cp.apple.finalcutpro.main.Browser.matches(element) -> boolean`
Type	Function
Description	Checks to see if an element matches what we think it should be.
Parameters	element - An `axuielementObject` to check.
Returns	`true` if matches otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 50

#Constructors

#Browser


Signature	`cp.apple.finalcutpro.main.Browser(app) -> Browser`
Type	Constructor
Description	Creates a new `Browser` instance.
Parameters	app - The Final Cut Pro app instance.
Returns	The new `Browser`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 67

#Fields

#generators


Signature	`cp.apple.finalcutpro.main.Browser.generators <cp.apple.finalcutpro.main.GeneratorsBrowser>`
Type	Field
Description	Generators Browser object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 354

#generatorsShowing


Signature	`cp.apple.finalcutpro.main.Browser.generatorsShowing <cp.prop: boolean; read-only>`
Type	Field
Description	Is the 'Generators' button active, and thus showing?
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 139

#isOnPrimary


Signature	`cp.apple.finalcutpro.main.Browser.isOnPrimary <cp.prop: boolean; read-only>`
Type	Field
Description	Is the Browser on the Primary Window?
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 115

#isOnSecondary


Signature	`cp.apple.finalcutpro.main.Browser.isOnSecondary <cp.prop: boolean; read-only>`
Type	Field
Description	Is the Browser on the Secondary Window?
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 105

#libraries


Signature	`cp.apple.finalcutpro.main.Browser.libraries <cp.apple.finalcutpro.main.LibrariesBrowser>`
Type	Field
Description	The module object.
Parameters	None
Returns	A `LibrariesBrowser` object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 334

#librariesShowing


Signature	`cp.apple.finalcutpro.main.Browser.librariesShowing <cp.prop: boolean; read-only>`
Type	Field
Description	Is the 'Libraries' button active, and thus showing?
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 125

#markerPopover


Signature	`cp.apple.finalcutpro.main.Browser.markerPopover <BrowserMarkerPopover>`
Type	Field
Description	The Browser Marker Popover object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 361

#media


Signature	`cp.apple.finalcutpro.main.Browser.media <cp.apple.finalcutpro.main.MediaBrowser>`
Type	Field
Description	The Media Browser object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 347

#mediaShowing


Signature	`cp.apple.finalcutpro.main.Browser.mediaShowing <cp.prop: boolean; read-only>`
Type	Field
Description	Is the 'Media' button active, and thus showing?
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 132

#showGenerators


Signature	`cp.apple.finalcutpro.main.Browser.showGenerators <cp.ui.CheckBox>`
Type	Field
Description	The CheckBox indicating if the Generators Browser is showing.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 320

#showLibraries


Signature	`cp.apple.finalcutpro.main.Browser.showLibraries <cp.ui.CheckBox>`
Type	Field
Description	Indicates if Libraries is showing, and can be clicked to toggle.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 292

#showMedia


Signature	`cp.apple.finalcutpro.main.Browser.showMedia <cp.ui.CheckBox>`
Type	Field
Description	CheckBox indicating if the Media Browser is showing.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 306

#Methods

#appearanceAndFiltering


Signature	`cp.apple.finalcutpro.main.Browser.appearanceAndFiltering <cp.apple.finalcutpro.main.AppearanceAndFiltering>`
Type	Method
Description	The Clip AppearanceAndFiltering Menu Popover
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesBrowser.lua line 256

#doHide


Signature	`cp.apple.finalcutpro.main.Browser:doHide() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will hide the Browser.
Parameters	None
Returns	The `Statement` to execute.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 271

#doShow


Signature	`cp.apple.finalcutpro.main.Browser:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will ensure the Browser is showing. If it's currently showing on the Secondary Screen it will stay there, otherwise it will get shown on the Primary Screen.
Parameters	None
Returns	The `Statement` to execute.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 239

#doShowOnPrimary


Signature	`cp.apple.finalcutpro.main.Browser:doShowOnPrimary() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will show the Browser on Primary Screen.
Parameters	None
Returns	The `Statement` to execute.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 176

#doShowOnSecondary


Signature	`cp.apple.finalcutpro.main.Browser:doShowOnSecondary() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will show the Browser on Secondary Screen.
Parameters	None
Returns	The `Statement` to execute.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 218

#hide


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

#loadLayout


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

#saveLayout


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

#showOnPrimary


Signature	`cp.apple.finalcutpro.main.Browser:showOnPrimary() -> Browser`
Type	Method
Description	Show Browser on Primary Screen.
Parameters	None
Returns	The `Browser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 152

#showOnSecondary


Signature	`cp.apple.finalcutpro.main.Browser:showOnSecondary() -> Browser`
Type	Method
Description	Show Browser on Secondary Screen.
Parameters	None
Returns	The `Browser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/Browser.lua line 199