#cp.apple.finalcutpro.main.PrimaryWindow

Primary Window Module.

#API Overview

Functions - API calls offered directly by the extension

matches

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

PrimaryWindow

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

alert
bottomGroupUI
browserGroupUI
colorBoard
doShow
frame
hsWindow
inspector
isFullScreen
isShowing
leftGroupUI
rightGroupUI
rootGroupUI
timelineGroupUI
toolbar
topGroupUI
UI
viewerGroupUI
window

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

app
show

#API Documentation

#Functions

#matches


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.matches(w) -> boolean`
Type	Function
Description	Checks to see if a window matches the PrimaryWindow requirements
Parameters	w - The window to check
Returns	`true` if matched otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 24

#Constructors

#PrimaryWindow


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

#Fields

#alert


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.alert <cp.ui.Alert>`
Type	Field
Description	Provides access to any 'Alert' windows on the PrimaryWindow.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 335

#bottomGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow:bottomGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the bottom group UI as a `hs.axuielement` object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 201

#browserGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.browserGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the UI which contains the Browser.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 252

#colorBoard


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.colorBoard <ColorBoard>`
Type	Field
Description	The ColorBoard object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 309

#doShow


Signature	`cp.apple.finalcutpro.main.PrimaryWindow:doShow() -> PrimaryWindow`
Type	Field
Description	A Statement that attempts to show the Primary Window.
Returns	The `Statement`, which resolves as either `true` or sends an error.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 276

#frame


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

#hsWindow


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.hsWindow <cp.prop: hs.window; read-only>`
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/PrimaryWindow.lua line 86

#inspector


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.inspector <Inspector>`
Type	Field
Description	The Inspector object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 296

#isFullScreen


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

#isShowing


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.isShowing <cp.prop: boolean>`
Type	Field
Description	Is `true` if the window is visible.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 93

#leftGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.leftGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the left group UI as a `hs.axuielement` object
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 125

#rightGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.rightGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the right group UI as a `hs.axuielement` object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 145

#rootGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.rootGroupUI() <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the top AXSplitGroup as a `hs.axuielement` object
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 114

#timelineGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.timelineGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the UI that contains the `Timeline`.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 245


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.toolbar <cp.ui.PrimaryToolbar>`
Type	Field
Description	The PrimaryToolbar element.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 322

#topGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.topGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the top group UI as a `hs.axuielement` object.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 162

#UI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.UI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	The main `axuielement` for the window. May be `nil` if not currently available.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 74

#viewerGroupUI


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.viewerGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	Returns the UI that contains the `Viewer`.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 238

#window


Signature	`cp.apple.finalcutpro.main.PrimaryWindow.window <cp.ui.Window>`
Type	Field
Description	The `Window` instance.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 67

#Methods

#app


Signature	`cp.apple.finalcutpro.main.PrimaryWindow:app() -> cp.apple.finalcutpro`
Type	Method
Description	Returns the application the display belongs to.
Parameters	None
Returns	The app instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 54

#show


Signature	`cp.apple.finalcutpro.main.PrimaryWindow:show() -> PrimaryWindow`
Type	Method
Description	Shows the Primary Window.
Parameters	None
Returns	The `PrimaryWindow` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 259