#cp.ui.List

Represents an AXList axuielement value.

Extends Element.


#API Overview

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Functions

Signaturecp.ui.List.matches(element)
TypeFunction
DescriptionChecks if the provided axuielement is an AXList.
Parameters
  • element - The axuielement to check.
Returns
  • true if it is an AXList, otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/List.lua line 14

#Constructors

Signaturecp.ui.List(parent, uiFinder, itemAdaptorFn)
TypeConstructor
DescriptionCreates a new List.
Parameters
  • parent - The parent table. Should have a isShowing property.
  • uiFinder - The function or cp.prop that provides the current hs.axuielement.
  • itemAdaptorFn - Item adapter function
Returns
  • The new List instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/List.lua line 27

#Methods

Signaturecp.ui.List:items() -> table of values
TypeMethod
DescriptionReturns the children as items, as adapted by the itemAdaptor in the constructor
Parameters
  • None
Returns
  • A table
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/List.lua line 51