# cp.ui.Group

UI Group.

# Submodules

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


Signature	`cp.ui.Group:containing(...) -> cp.ui.Group.Builder`
Type	Function
Description	Returns 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`
Notes	None
Examples	None
Source	src/extensions/cp/ui/Group.lua line 21


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`
Notes	None
Examples	None
Source	src/extensions/cp/ui/Group.lua line 31


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.axuielement` when available. --- - Anything else
Returns	A new `Group` object.
Notes	None
Examples	None
Source	src/extensions/cp/ui/Group.lua line 44


Signature	`cp.ui.Group.children <table of cp.ui.Element>`
Type	Field
Description	Contains the list of `Element` children of the group.
Notes	None
Source	src/extensions/cp/ui/Group.lua line 67


Signature	`cp.ui.Group.childrenUI <cp.prop: table of axuielement>`
Type	Field
Description	Contains the list of `axuielement` children of the group.
Notes	None
Source	src/extensions/cp/ui/Group.lua line 60