cp.apple.finalcutpro.main.PrimaryWindow.md

docs » 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

Constructors

PrimaryWindow

Signature	cp.apple.finalcutpro.main.PrimaryWindow(app) -> PrimaryWindow object
Type	Constructor
Description	Creates a new PrimaryWindow.
Parameters	None
Returns	PrimaryWindow

Fields

alert

Signature	cp.apple.finalcutpro.main.PrimaryWindow.alert <cp.ui.Alert>
Type	Field
Description	Provides access to any 'Alert' windows on the PrimaryWindow.

bottomGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:bottomGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the bottom group UI as a hs._asm.axuielement object.

browserGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.browserGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the UI which contains the Browser.

colorBoard

Signature	cp.apple.finalcutpro.main.PrimaryWindow.colorBoard <ColorBoard>
Type	Field
Description	The ColorBoard object.

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.

frame

Signature	cp.apple.finalcutpro.main.PrimaryWindow.frame <cp.prop: frame>
Type	Field
Description	The current position (x, y, width, height) of the window.

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.

inspector

Signature	cp.apple.finalcutpro.main.PrimaryWindow.inspector <Inspector>
Type	Field
Description	The Inspector object.

isFullScreen

Signature	cp.apple.finalcutpro.main.PrimaryWindow.isFullScreen <cp.prop: boolean>
Type	Field
Description	Is true if the window is full-screen.

isShowing

Signature	cp.apple.finalcutpro.main.PrimaryWindow.isShowing <cp.prop: boolean>
Type	Field
Description	Is true if the window is visible.

leftGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.leftGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the left group UI as a hs._asm.axuielement object

rightGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.rightGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the right group UI as a hs._asm.axuielement object.

rootGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.rootGroupUI() <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the top AXSplitGroup as a hs._asm.axuielement object

timelineGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.timelineGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the UI that contains the Timeline.

toolbar

Signature	cp.apple.finalcutpro.main.PrimaryWindow.toolbar <cp.ui.PrimaryToolbar>
Type	Field
Description	The PrimaryToolbar element.

topGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.topGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the top group UI as a hs._asm.axuielement object.

UI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.UI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	The main axuielement for the window. May be nil if not currently available.

viewerGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.viewerGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the UI that contains the Viewer.

window

Signature	cp.apple.finalcutpro.main.PrimaryWindow.window <cp.ui.Window>
Type	Field
Description	The Window instance.

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.

show

Signature	cp.apple.finalcutpro.main.PrimaryWindow:show() -> PrimaryWindow
Type	Method
Description	Shows the Primary Window.
Parameters	None
Returns	The PrimaryWindow instance.