# cp.ui.Group

UI Group.

---

## Submodules
 * [cp.ui.Group.Builder](cp.ui.Group.Builder.md)

---

## API Overview
**Functions** - _API calls offered directly by the extension_
 * [containing](#containing)
 * [matches](#matches)

**Constructors** - _API calls which return an object, typically one that offers API methods_
 * [Group](#group)

**Fields** - _Variables which can only be accessed from an object returned by a constructor_
 * [children](#children)
 * [childrenUI](#childrenui)

---

## API Documentation

#### Functions

### [containing](#containing)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **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**                              | <ul><li>... - A variable list of `Element` initializers, one for each child.</li></ul> |
| **Returns**                                 | <ul><li>The `Group.Builder`</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/ui/Group.lua line 21](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Group.lua#L21) |

---

### [matches](#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**                              | <ul><li>element - An `axuielementObject` to check.</li></ul> |
| **Returns**                                 | <ul><li>`true` if matches otherwise `false`</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/ui/Group.lua line 31](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Group.lua#L31) |

---

#### Constructors

### [Group](#group)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `cp.ui.Group(parent, uiFinder[, contentsClass]) -> Alert`                                                                    |
| **Type**                                    | Constructor                                                                     |
| **Description**                             | Creates a new `Group` instance.                                                                     |
| **Parameters**                              | <ul><li>parent - The parent object.</li><li>uiFinder - A function which will return the `hs.axuielement` when available.</li><li>--- - Anything else</li></ul> |
| **Returns**                                 | <ul><li>A new `Group` object.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/ui/Group.lua line 44](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Group.lua#L44) |

---

#### Fields

### [children](#children)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Group.lua#L67) |

---

### [childrenUI](#childrenui)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Group.lua#L60) |

---

---

<script src="https://giscus.app/client.js"
        data-repo="CommandPost/CommandPost"
        data-repo-id="MDEwOlJlcG9zaXRvcnk3NDY0NTk2NQ=="
        data-category="Website Discussion"
        data-category-id="DIC_kwDOBHMBzc4CXFFA"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="dark"
        data-lang="en"
        crossorigin="anonymous"
        async>
</script>
