ScrollArea

Last updated 4 months ago

Scroll Area Module.

API Overview

API Documentation

Functions

matches

Signature

cp.ui.ScrollArea.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.ui.ScrollArea.new(parent, finderFn) -> cp.ui.ScrollArea

Type

Constructor

Description

Creates a new ScrollArea.

Parameters

Returns

Methods

app

Signature

cp.ui.ScrollArea:app() -> App

Type

Method

Description

Returns the app instance representing Final Cut Pro.

Parameters

Returns

Signature

`cp.ui.ScrollArea:childrenUI(filterFn) -> hs._asm.axuielement

nil` </span>

Type

Method

Description

Returns the axuielement representing the Scroll Area Contents, or nil if not available.

Parameters

Signature

`cp.ui.ScrollArea:contentsUI() -> hs._asm.axuielement

nil` </span>

Type

Method

Description

Returns the axuielement representing the Scroll Area Contents, or nil if not available.

Parameters

Signature

cp.ui.ScrollArea:deselectAll() -> self

Type

Method

Description

Deselect all children in a scroll area.

Parameters

Signature

`cp.ui.ScrollArea:horizontalScrollBarUI() -> hs._asm.axuielement

nil` </span>

Type

Method

Description

Returns the axuielement representing the Horizontal Scroll Bar, or nil if not available.

Parameters

isShowing

Signature

cp.ui.ScrollArea:isShowing() -> boolean

Type

Method

Description

Is the Scroll Area showing?

Parameters

Signature

cp.ui.ScrollArea:loadLayout(layout) -> none

Type

Method

Description

Loads a Scroll Area layout.

Parameters

Returns

parent

Signature

cp.ui.ScrollArea:parent() -> table

Type

Method

Description

The parent object.

Parameters

Returns

Signature

cp.ui.ScrollArea:saveLayout() -> table

Type

Method

Description

Saves the current Scroll Area layout to a table.

Parameters

Returns

selectAll

Signature

cp.ui.ScrollArea:selectAll(childrenUI) -> self

Type

Method

Description

Select all children in a scroll area.

Parameters

Signature

cp.ui.ScrollArea:selectChild(childUI) -> self

Type

Method

Description

Select a specific child within a Scroll Area.

Parameters

Signature

cp.ui.ScrollArea:selectChildAt(index) -> self

Type

Method

Description

Select a child element in a Scroll Area given a specific index.

Parameters

Signature

`cp.ui.ScrollArea:selectedChildrenUI() -> hs._asm.axuielement

nil` </span>

Type

Method

Description

Returns the axuielement representing the Scroll Area Selected Children, or nil if not available.

Parameters

showChild

Signature

cp.ui.ScrollArea:showChild(childUI) -> self

Type

Method

Description

Show's a child element in a Scroll Area.

Parameters

Signature

cp.ui.ScrollArea:showChildAt(index) -> self

Type

Method

Description

Show's a child element in a Scroll Area given a specific index.

Parameters

snapshot

Signature

`cp.ui.ScrollArea:snapshot([path]) -> hs.image

nil` </span>

Type

Method

Description

Takes a snapshot of the UI in its current state as a PNG and returns it.

Parameters

UI

Signature

`cp.ui.ScrollArea:UI() -> hs._asm.axuielement

nil` </span>

Type

Method

Description

Returns the axuielement representing the ScrollArea, or nil if not available.

Parameters

Signature

`cp.ui.ScrollArea:verticalScrollBarUI() -> hs._asm.axuielement

nil` </span>

Type

Method

Description

Returns the axuielement representing the Vertical Scroll Bar, or nil if not available.

Parameters

viewFrame

Signature

cp.ui.ScrollArea:viewFrame() -> hs.geometry rect

Type

Method

Description

Returns the Scroll Area frame.

Parameters