#cp.ui.OldOutline

Represents an AXOutline axuielement.

#API Overview

Functions - API calls offered directly by the extension

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

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


Signature	`cp.ui.OldOutline.matches(element) -> boolean`
Type	Function
Description	Checks if the `element` is an `Outline`.
Parameters	element - An element to check
Returns	A boolean
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 89


Signature	`cp.ui.OldOutline(parent, uiFinder) -> cp.ui.OldOutline`
Type	Constructor
Description	Creates a new `Outline` with the specified `parent` and `uiFinder`.
Parameters	parent - The parent instance. uiFinder - A `function` or a `cp.prop` which will return the `AXOutline` `axuielement`.
Returns	The new `Outline` instance.
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 102


Signature	`cp.ui.OldOutline:childrenUI() -> table`
Type	Method
Description	Provides a `table` containing the `axuielement`s which are children of the outline.
Parameters	None
Returns	A table
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 118


Signature	`cp.ui.OldOutline:columns() -> table of cp.ui.Columns`
Type	Method
Description	Returns the list of Columns in this `Outline`.
Parameters	None
Returns	A table
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 162


Signature	`cp.ui.OldOutline:columnsUI() -> table`
Type	Method
Description	Provides a `table` containing the `axuielement`s which are columns of the outline.
Parameters	None
Returns	A Table
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 131


Signature	`cp.ui.OldOutline:createColumn(columnUI) -> cp.ui.OldColumn`
Type	Method
Description	Attempts to create a new Column with the provided `columnUI` `axuielement`. If there is a problem, an `error` is thrown.
Parameters	columnUI - the `AXColumn` `axuielement` to create a Column for.
Returns	The Column or an error if a problem occurred.
Notes	Subclasses which want to provide a custom Column implementation should override this method.
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 144


Signature	`cp.ui.OldOutline:createRow(rowUI) -> cp.ui.OldRow`
Type	Method
Description	Attempts to create a new Row with the provided `rowUI` `axuielement`. If there is a problem, an `error` is thrown.
Parameters	rowUI - the `AXRow` `axuielement` to create a Row for.
Returns	The Row or an error if a problem occurred.
Notes	Subclasses which want to provide a custom Row implementation should override this method.
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 218


Signature	`cp.ui.OldOutline:fetchColumn(columnsUI) -> table of cp.ui.Columns`
Type	Method
Description	Returns a `table` of the same length as `columnsUI`.
Parameters	columnsUI - The list of `AXColumn` `axuielement`s to find.
Returns	A `table` with the same number of elements, containing the matching Column instances.
Notes	If provided items in the table are not valid columns in this table, then `nil` will be put in the matching index. Note that this will break the standard `#`/looping behaviour for tables at that point.
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 188


Signature	`cp.ui.OldOutline:fetchRow(rowUI) -> cp.ui.OldRow or nil`
Type	Method
Description	Returns the Row that represents the provided `rowUI`, if it is actually present in the `Outline`.
Parameters	rowUI - The `axuielement` for the `AXRow` to find a Row for.
Returns	The Row, or `nil` if the `rowUI` is not in this `Outline`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 248


Signature	`cp.ui.OldOutline:fetchRows(rowsUI) -> table of cp.ui.OldRows`
Type	Method
Description	Returns a `table` of the same length as `rowsUI`.
Parameters	rowsUI - The list of `AXRow` `axuielement`s to find.
Returns	A `table` with the same number of elements, containing the matching Row instances.
Notes	If provided items in the table are not valid rows in this table, then `nil` will be put in the matching index. Note that this will break the standard `#`/looping behaviour for tables at that point.
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 261


Signature	`cp.ui.OldOutline:filterRows(matcherFn) -> table of cp.ui.OldRows or nil`
Type	Method
Description	Returns a table only containing Rows which pass the predicate `matcherFn`. The function is passed the row and returns a boolean.
Parameters	matcherFn - the `function` that will accept a Row and return a `boolean`.
Returns	A `table` of Rows, or `nil` if no UI is currently available.
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 278


Signature	`cp.ui.OldOutline:rows() -> table of cp.ui.OldRow or nil`
Type	Method
Description	Provides a `table` with the list of `cp.ui.OldRow` elements for the rows.
Parameters	None
Returns	A table containing the list of Rows in the `Outline`, or `nil` if the `Outline` is not presently available.
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 235


Signature	`cp.ui.OldOutline:rowsUI() -> table of axuielement`
Type	Method
Description	Provides a `table` containing the `axuielement`s which are rows in the outline.
Parameters	None
Returns	A table
Notes	None
Examples	None
Source	src/extensions/cp/ui/OldOutline.lua line 205