This repository was archived by the owner on Jun 9, 2023. It is now read-only.

42 lines (33 loc) · 2.87 KB

docs » cp.ui.Group

UI Group.

API Overview

Functions - API calls offered directly by the extension
contents
matches
Constructors - API calls which return an object, typically one that offers API methods
Group

API Documentation

Functions

contents

Signature	`cp.ui.Group.contents(element) -> axuielement`
Type	Function
Description	Returns the `AXContents` of the element, if it is an `AXGroup`.
Parameters	element - The `axuielement` to check.
Returns	The list of `axuielements` for the `AXContents` of the `AXGroup`, or `nil`.

matches

Signature	`cp.ui.Group.matches(element) -> boolean`
Type	Function
Description	Checks to see if an element matches what we think it should be.
Parameters	element - An `axuielementObject` to check.
Returns	`true` if matches otherwise `false`

Constructors

Group

Signature	`cp.ui.Group(parent, uiFinder[, contentsClass]) -> Alert`
Type	Constructor
Description	Creates a new `Group` instance.
Parameters	parent - The parent object. uiFinder - A function which will return the `hs._asm.axuielement` when available.
Returns	A new `Group` object.