cp.ui.Row.md

docs » cp.ui.Row

---

Represents an AXRow axuielement.

API Overview

• Constructors - API calls which return an object, typically one that offers API methods
• Row
• Fields - Variables which can only be accessed from an object returned by a constructor
• disclosing
• disclosureLevel
• index
• selected
• Methods - API calls which can only be made on an object returned by a constructor
• disclosedByRow
• disclosedRows
• matches

API Documentation

Constructors

Row

Signature	cp.ui.Row(parent, uiFinder) -> cp.ui.Row
Type	Constructor
Description	Creates a new Row instance with the specified parent and uiFinder.
Parameters	parent - the parent Element. uiFinder - a function or cp.prop containing the axuielement
Returns	The new Row.

Fields

disclosing

Signature	cp.ui.Row.disclosing <cp.prop: boolean>
Type	Field
Description	Indicates if the Row is disclosing other Rows.

disclosureLevel

Signature	cp.ui.Row.disclosureLevel <cp.prop: number; read-only>
Type	Field
Description	The depth of disclosure. 0 is the top level.

index

Signature	cp.ui.Row.index <cp.prop: number; read-only>
Type	Field
Description	The numeric index of this row in the overall container, with 0 being the first item.

selected

Signature	cp.ui.Row.selected <cp.prop: boolean>
Type	Field
Description	Indicates if the row is currently selected. May be set.

Methods

disclosedByRow

Signature	cp.ui.Row:disclosedByRow() -> cp.ui.Row
Type	Method
Description	The Row which is disclosing this Row.

disclosedRows

Signature	cp.ui.Row:disclosedRows() -> table of cp.ui.Row or nil
Type	Method
Description	If available, returns a table of Rows that are disclosed by this Row.
Returns	The table of Rows, or nil.

matches

Signature	cp.ui.Row.matches(element) -> boolean
Type	Method
Description	Checks if the element is a Row.
Parameters	element - the axuielement to check.
Returns	true if it matches, otherwise false.