#cp.ui.TextArea

UI Text Area.

#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


Signature	`cp.ui.TextArea.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/TextArea.lua line 21


Signature	`cp.ui.TextArea(parent, uiFinder) -> TextArea`
Type	Constructor
Description	Creates a new `TextArea` instance.
Parameters	parent - The parent object. uiFinder - A function which will return the `hs.axuielement` when available.
Returns	A new `TextArea` object.
Notes	None
Examples	None
Source	src/extensions/cp/ui/TextArea.lua line 9


Signature	`cp.ui.TextArea.value <cp.prop: string>`
Type	Field
Description	The current value of the text field.
Notes	None
Source	src/extensions/cp/ui/TextArea.lua line 34


Signature	`cp.ui.TextArea:append(moreText) -> string`
Type	Method
Description	Appends `moreText` to the end of the current value, returning the combined text value. If no text is currently set, `moreText` becomes the value.
Parameters	moreText - The text to add.
Returns	The combined `string` value.
Notes	None
Examples	None
Source	src/extensions/cp/ui/TextArea.lua line 55


Signature	`cp.ui.TextArea:prepend(moreText) -> string`
Type	Method
Description	Appends `moreText` to the beginning of the current value, returning the combined text value. If no text is currently set, `moreText` becomes the value.
Parameters	moreText - The text to add.
Returns	The combined `string` value.
Notes	None
Examples	None
Source	src/extensions/cp/ui/TextArea.lua line 70