PrimaryWindow

Last updated 23 days ago

Primary Window Module.

API Overview

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

Returns

Fields

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.

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.

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.

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.

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

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.

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

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.

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: axuielement; read-only>

Type

Field

Description

The axuielement for the window.

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.

Methods

alert

Signature

cp.apple.finalcutpro.main.PrimaryWindow:alert() -> cp.ui.Alert

Type

Method

Description

Provides access to any 'Alert' windows on the PrimaryWindow.

Parameters

Returns

app

Signature

cp.apple.finalcutpro.main.PrimaryWindow:app() -> hs.application

Type

Method

Description

Returns the application the display belongs to.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.PrimaryWindow:colorBoard() -> ColorBoard

Type

Method

Description

Gets the ColorBoard object.

Parameters

Returns

inspector

Signature

cp.apple.finalcutpro.main.PrimaryWindow:inspector() -> Inspector

Type

Method

Description

Gets the Inspector object.

Parameters

Returns

new

Signature

cp.apple.finalcutpro.main.PrimaryWindow.new(app) -> PrimaryWindow object

Type

Method

Description

Creates a new PrimaryWindow.

Parameters

Returns

show

Signature

cp.apple.finalcutpro.main.PrimaryWindow:show() -> PrimaryWindow

Type

Method

Description

Shows the Primary Window.

Parameters

Returns

toolbar

Signature

cp.apple.finalcutpro.main.PrimaryWindow:toolbar() -> PrimaryToolbar

Type

Method

Description

Returns the PrimaryToolbar element.

Parameters

Returns

window

Signature

cp.apple.finalcutpro.main.PrimaryWindow:window() -> cp.ui.Window

Type

Method

Description

Returns the Window instance.

Parameters

Returns