PropertyRow

Last updated 9 months ago

Represents a single property row, typically in a Property Inspector.

API Overview

API Documentation

Functions

isParent

Signature

cp.ui.PropertyRow.isParent(parent) -> boolean

Type

Function

Description

Checks if the parent has been prepared via prepareParent.

Parameters

Returns

matches

Signature

cp.ui.PropertyRow.matches(element) -> boolean

Type

Function

Description

Checks if the provided axuielement could be a property row.

Parameters

Returns

Signature

cp.ui.PropertyRow.parentUIFinder(parent) -> cp.prop

Type

Function

Description

Returns the cp.prop which finds the hs._asm.axuielement that contains property rows from the parent.

Parameters

Returns

Signature

cp.ui.PropertyRow.prepareParent(parent, uiFinder) -> none

Type

Function

Description

Call this to make parent table ready to be a parent of PropertyRows.

Parameters

Returns

Constructors

new

Signature

cp.ui.PropertyRow.new(parent, labelKey[, index]) -> cp.ui.PropertyRow

Type

Constructor

Description

Creates a new PropertyRow with the specified parent and label key.

Parameters

Returns

Fields

isShowing

Signature

cp.ui.PropertyRow.isShowing <cp.prop: boolean; read-only>

Type

Field

Description

Checks if the row is showing.

label

Signature

cp.ui.PropertyRow.label <cp.prop: string; read-only>

Type

Field

Description

The label of the property row, in the current langauge.

labelUI

Signature

cp.ui.PropertyRow.labelUI <cp.prop: hs._asm.axuielement; read-only>

Type

Field

Description

The axuielement containing the row label.

Signature

cp.ui.PropertyRow.propertiesUI <cp.prop: hs._asm.axuielement; read-only>

Type

Field

Description

The axuielement from the parent that contains the properties.

reset

Signature

cp.ui.PropertyRow.reset <cp.ui.Button>

Type

Field

Description

The reset button for the row, which may or may not actually exist.

UI

Signature

cp.ui.PropertyRow.UI <cp.prop: hs._asm.axuielement; read-only>

Type

Field

Description

Returns the axuielement for the row.

Methods

app

Signature

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

Type

Method

Description

Returns the app instance.

Parameters

Returns

children

Signature

`cp.ui.PropertyRow:children() -> table

nil` </span>

Type

Method

Description

Gets a table of children for the Property Row.

Parameters

Returns

hide

Signature

cp.ui.PropertyRow:hide() -> self

Type

Method

Description

Hides the PropertyRow.

Parameters

Returns

labelKeys

Signature

cp.ui.PropertyRow:labelKeys() -> string

Type

Method

Description

Gets the key of the label that the row will map to.

Parameters

Returns

parent

Signature

cp.ui.PropertyRow:parent() -> parent

Type

Method

Description

Returns the parent object.

Parameters

Returns

show

Signature

cp.ui.PropertyRow:show() -> self

Type

Method

Description

Shows the PropertyRow.

Parameters

Returns