List

​
Represents an AXList axuielement value.
Extends Element.
API Overview
Functions - API calls offered directly by the extension
​matches​
Constructors - API calls which return an object, typically one that offers API methods
​List​
Methods - API calls which can only be made on an object returned by a constructor
​items​
API Documentation
Functions
​matches​
Signature
cp.ui.List.matches(element)
Type
Function
Description
Checks if the provided axuielement is an AXList.
Parameters
element - The axuielement to check.
Returns
true if it is an AXList, otherwise false.
Constructors
​List​
Signature
cp.ui.List(parent, uiFinder, itemAdaptorFn)
Type
Constructor
Description
Creates a new List.
Parameters
parent - The parent table. Should have a isShowing property.
uiFinder - The function or cp.prop that provides the current hs._asm.axuielement.
Returns
The new List instance.
Methods
​items​
Signature
cp.ui.List:items() -> table of values
Type
Method
Description
Returns the children as items, as adapted by the itemAdaptor in the constructor

Last modified 1yr ago

Signature	`cp.ui.List.matches(element)`
Type	Function
Description	Checks if the provided `axuielement` is an `AXList`.
Parameters	element - The `axuielement` to check.
Returns	`true` if it is an `AXList`, otherwise `false`.

Signature	`cp.ui.List(parent, uiFinder, itemAdaptorFn)`
Type	Constructor
Description	Creates a new List.
Parameters	parent - The parent table. Should have a `isShowing` property. uiFinder - The `function` or `cp.prop` that provides the current `hs._asm.axuielement`.
Returns	The new `List` instance.

Signature	`cp.ui.List:items() -> table of values`
Type	Method
Description	Returns the children as items, as adapted by the `itemAdaptor` in the constructor

List

API Overview

API Documentation

Functions

​matches​

Constructors

​List​

Methods

​items​

matches

List

items