FullScreenWindow

Last updated 2 months ago

Full Screen Window

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

API Documentation

Functions

matches

Signature

cp.apple.finalcutpro.main.FullScreenWindow.matches(element) -> boolean

Type

Function

Description

Checks to see if an element matches what we think it should be.

Parameters

Returns

Constructors

new

Signature

cp.apple.finalcutpro.main.FullScreenWindow.new(app) -> FullScreenWindow

Type

Constructor

Description

Creates a new FCPX FullScreenWindow instance.

Parameters

Returns

Fields

Signature

cp.apple.finalcutpro.main.FullScreenWindow.isFullScreen <cp.prop; boolean; read-only; live>

Type

Field

Description

Checks if the window is full-screen.

isShowing

Signature

cp.apple.finalcutpro.main.FullScreenWindow.isShowing <cp.prop; boolean; read-only; live>

Type

Field

Description

Checks if the window is currently showing.

Signature

cp.apple.finalcutpro.main.FullScreenWindow.rootGroupUI <cp.prop: hs._asm.axuielement; read-only; live>

Type

Field

Description

The root AXGroup.

UI

Signature

cp.apple.finalcutpro.main.FullScreenWindow.UI <cp.prop: hs._asm.axuielement; read-only; live>

Type

Field

Description

The core axuielement for the window.

Signature

cp.apple.finalcutpro.main.FullScreenWindow.viewerGroupUI <cp.prop: hs._asm.axuielement; read-only; live>

Type

Field

Description

The Viewer's group UI element.

Methods

app

Signature

cp.apple.finalcutpro.main.FullScreenWindow:app() -> cp.apple.finalcutpro

Type

Method

Description

Returns the FCPX app.

Parameters

Returns

show

Signature

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

Type

Method

Description

Attempts to show the full screen window.

Parameters

Returns

window

Signature

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

Type

Method

Description

Returns the Window instance for the full-screen window.

Parameters

Returns