# cp.ui.Row

Represents an AXRow axuielement.

# Submodules

# API Overview

Functions - API calls offered directly by the extension

  • containing

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

  • Row

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

  • childrenUI
  • disclosing
  • disclosureLevel
  • index
  • selected

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

  • disclosedByRow
  • disclosedRows
  • matches

# API Documentation

# Functions

# containing

Signature cp.ui.Row:containing(...) -> cp.ui.Row.Builder
Type Function
Description Returns a Builder with the Element initializers for the items in the row.
Parameters
  • ... - A variable list of Element initializers, one for each item.
Returns
  • The Row.Builder
Notes None
Examples None
Source src/extensions/cp/ui/Row.lua line 17

# Constructors

# Row

Signature cp.ui.Row(parent, uiFinder, ...) -> cp.ui.Row
Type Constructor
Description Creates a new Row instance with the specified parent and uiFinder.
Parameters
  • parent - the parent Element.
  • uiFinder - a function or cp.prop containing the axuielement
  • ... - a variable list of Element initializers, one for each item in the row.
Returns
  • The new Row.
Notes None
Examples None
Source src/extensions/cp/ui/Row.lua line 38

# Fields

# childrenUI

Signature cp.ui.Row.childrenUI <cp.prop: table of axuielement>
Type Field
Description Contains the list of axuielement children of the row.
Notes None
Source src/extensions/cp/ui/Row.lua line 54

# disclosing

Signature cp.ui.Row.disclosing <cp.prop: boolean>
Type Field
Description Indicates if the Row is disclosing other Rows.
Notes None
Source src/extensions/cp/ui/Row.lua line 68

# disclosureLevel

Signature cp.ui.Row.disclosureLevel <cp.prop: number; read-only>
Type Field
Description The depth of disclosure. 0 is the top level.
Notes None
Source src/extensions/cp/ui/Row.lua line 75

# index

Signature cp.ui.Row.index <cp.prop: number; read-only>
Type Field
Description The numeric index of this row in the overall container, with 0 being the first item.
Notes None
Source src/extensions/cp/ui/Row.lua line 123

# selected

Signature cp.ui.Row.selected <cp.prop: boolean>
Type Field
Description Indicates if the row is currently selected. May be set.
Notes None
Source src/extensions/cp/ui/Row.lua line 116

# Methods

# disclosedByRow

Signature cp.ui.Row:disclosedByRow() -> cp.ui.Row
Type Method
Description The Row which is disclosing this Row.
Parameters
  • None
Returns
  • A cp.ui.Row object
Notes None
Examples None
Source src/extensions/cp/ui/Row.lua line 82

# disclosedRows

Signature cp.ui.Row:disclosedRows() -> table of cp.ui.Row or nil
Type Method
Description If available, returns a table of Rows that are disclosed by this Row. If this row is currently unavailable, nil is returned.
Parameters
  • None
Returns
  • The table of Rows, or nil.
Notes None
Examples None
Source src/extensions/cp/ui/Row.lua line 97

# matches

Signature cp.ui.Row.matches(element) -> boolean
Type Method
Description Checks if the element is a Row.
Parameters
  • element - the axuielement to check.
Returns
  • true if it matches, otherwise false.
Notes None
Examples None
Source src/extensions/cp/ui/Row.lua line 27

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.