#cp.apple.finalcutpro.main.SecondaryWindow

Secondary Window Module.

#API Overview

Functions - API calls offered directly by the extension

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

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

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


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.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/SecondaryWindow.lua line 24


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


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.browserGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	The UI element that will contain the `Browser` if it's on the Secondary Window.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 114


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.frame <cp.prop: frame>`
Type	Field
Description	The current position (x, y, width, height) of the window.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 88


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.hsWindow <cp.prop: hs.window; read-only; live>`
Type	Field
Description	The `hs.window` instance for the window, or `nil` if it can't be found.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 67


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.isFullScreen <cp.prop: boolean; live>`
Type	Field
Description	Is `true` if the window is full-screen.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 81


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.isShowing <cp.prop: boolean; read-only; live>`
Type	Field
Description	Is `true` if the window is visible.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 74


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.rootGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	The root UI element on the window.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 95


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.timelineGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	The UI element that will contain the `Timeline` if it's on the Secondary Window.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 121


Signature	`cp.apple.finalcutpro.main.SecondaryWindow.viewerGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	The UI element that will contain the `Viewer` if it's on the Secondary Window.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 107


Signature	`cp.apple.finalcutpro.main.SecondaryWindow:app() -> App`
Type	Method
Description	Returns the app instance representing Final Cut Pro.
Parameters	None
Returns	App
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 142


Signature	`cp.apple.finalcutpro.main.SecondaryWindow:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that shows the Secondary Window.
Parameters	None
Returns	The `SecondaryWindow` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 173


Signature	`cp.apple.finalcutpro.main.SecondaryWindow:show() -> SecondaryWindow`
Type	Method
Description	Show the Secondary Window.
Parameters	None
Returns	The `SecondaryWindow` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/SecondaryWindow.lua line 155