#cp.ui.Row

Represents an AXRow axuielement.


#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

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


#API Documentation

#Functions

Signaturecp.ui.Row:containing(...) -> cp.ui.Row.Builder
TypeFunction
DescriptionReturns 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
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Row.lua line 17

#Constructors

Signaturecp.ui.Row(parent, uiFinder, ...) -> cp.ui.Row
TypeConstructor
DescriptionCreates 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.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Row.lua line 38

#Fields

Signaturecp.ui.Row.childrenUI <cp.prop: table of axuielement>
TypeField
DescriptionContains the list of axuielement children of the row.
NotesNone
Sourcesrc/extensions/cp/ui/Row.lua line 54

Signaturecp.ui.Row.disclosing <cp.prop: boolean>
TypeField
DescriptionIndicates if the Row is disclosing other Rows.
NotesNone
Sourcesrc/extensions/cp/ui/Row.lua line 68

Signaturecp.ui.Row.disclosureLevel <cp.prop: number; read-only>
TypeField
DescriptionThe depth of disclosure. 0 is the top level.
NotesNone
Sourcesrc/extensions/cp/ui/Row.lua line 75

Signaturecp.ui.Row.index <cp.prop: number; read-only>
TypeField
DescriptionThe numeric index of this row in the overall container, with 0 being the first item.
NotesNone
Sourcesrc/extensions/cp/ui/Row.lua line 123

Signaturecp.ui.Row.selected <cp.prop: boolean>
TypeField
DescriptionIndicates if the row is currently selected. May be set.
NotesNone
Sourcesrc/extensions/cp/ui/Row.lua line 116

#Methods

Signaturecp.ui.Row:disclosedByRow() -> cp.ui.Row
TypeMethod
DescriptionThe Row which is disclosing this Row.
Parameters
  • None
Returns
  • A cp.ui.Row object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Row.lua line 82

Signaturecp.ui.Row:disclosedRows() -> table of cp.ui.Row or nil
TypeMethod
DescriptionIf 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.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Row.lua line 97

Signaturecp.ui.Row.matches(element) -> boolean
TypeMethod
DescriptionChecks if the element is a Row.
Parameters
  • element - the axuielement to check.
Returns
  • true if it matches, otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Row.lua line 27