#cp.ui.Group

UI Group.


#Submodules


#API Overview

Functions - API calls offered directly by the extension

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

Fields - Variables which can only be accessed from an object returned by a constructor


#API Documentation

#Functions

Signaturecp.ui.Group:containing(...) -> cp.ui.Group.Builder
TypeFunction
DescriptionReturns a Builder with the Element initializers for the children in the group.
Parameters
  • ... - A variable list of Element initializers, one for each child.
Returns
  • The Group.Builder
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Group.lua line 21

Signaturecp.ui.Group.matches(element) -> boolean
TypeFunction
DescriptionChecks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Group.lua line 31

#Constructors

Signaturecp.ui.Group(parent, uiFinder[, contentsClass]) -> Alert
TypeConstructor
DescriptionCreates a new Group instance.
Parameters
  • parent - The parent object.
  • uiFinder - A function which will return the hs.axuielement when available.
  • --- - Anything else
Returns
  • A new Group object.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Group.lua line 44

#Fields

Signaturecp.ui.Group.children <table of cp.ui.Element>
TypeField
DescriptionContains the list of Element children of the group.
NotesNone
Sourcesrc/extensions/cp/ui/Group.lua line 67

Signaturecp.ui.Group.childrenUI <cp.prop: table of axuielement>
TypeField
DescriptionContains the list of axuielement children of the group.
NotesNone
Sourcesrc/extensions/cp/ui/Group.lua line 60