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
• Fields - Variables which can only be accessed from an object returned by a constructor
• frame
• isFullScreen
• isShowing
• UI
• Methods - API calls which can only be made on an object returned by a constructor
• app
• bottomGroupUI
• browserGroupUI
• colorBoard
• inspector
• leftGroupUI
• new
• rightGroupUI
• rootGroupUI
• show
• timelineGroupUI
• topGroupUI
• unwatch
• viewerGroupUI
• watch
• window

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

Fields

frame

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

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.

UI

Signature	cp.apple.finalcutpro.main.PrimaryWindow.UI <cp.prop: axuielement; read-only>
Type	Field
Description	The axuielement for the window.

Methods

app

Signature	cp.apple.finalcutpro.main.PrimaryWindow:app() -> hs.application
Type	Method
Description	Returns the application the display belongs to.
Parameters	None
Returns	The app instance.

bottomGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:bottomGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the bottom group UI as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

browserGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:browserGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the browser group UI as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

colorBoard

Signature	cp.apple.finalcutpro.main.PrimaryWindow:colorBoard() -> ColorBoard
Type	Method
Description	Gets the ColorBoard object.
Parameters	None
Returns	ColorBoard

inspector

Signature	cp.apple.finalcutpro.main.PrimaryWindow:inspector() -> Inspector
Type	Method
Description	Gets the Inspector object.
Parameters	None
Returns	Inspector

leftGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:leftGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the left group UI as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

new

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

rightGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:rightGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the right group UI as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

rootGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:rootGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the top AXSplitGroup as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

show

Signature	cp.apple.finalcutpro.main.PrimaryWindow:show() -> PrimaryWindow
Type	Method
Description	Attempts to focus the specified window.
Parameters	None
Returns	true if the window exists and

timelineGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:timelineGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the timeline group UI as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

topGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:topGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the top group UI as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

unwatch

Signature	cp.apple.finalcutpro.main.PrimaryWindow:unwatch() -> string
Type	Method
Description	Un-watches an event based on the specified ID.
Parameters	id - An ID has returned by watch
Returns	None

viewerGroupUI

Signature	cp.apple.finalcutpro.main.PrimaryWindow:viewerGroupUI() -> hs._asm.axuielement object
Type	Method
Description	Returns the viewer group UI as a hs._asm.axuielement object
Parameters	None
Returns	An hs._asm.axuielement object

watch

Signature	cp.apple.finalcutpro.main.PrimaryWindow:watch() -> string
Type	Method
Description	Watch for events that happen in the command editor
Parameters	events - A table of functions with to watch. These may be: show(window) - Triggered when the window is shown. hide(window) - Triggered when the window is hidden. move(window) - Triggered when the window is moved.
Returns	An ID which can be passed to unwatch to stop watching.

window

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