# cp.ui.axutils.match

Contains common hs.axuielement matching functions.

# API Overview

Functions - API calls offered directly by the extension

emptyList
exactly
isAbove
isBelow
isLeftOf
isRightOf
role

# API Documentation

# Functions

# emptyList


Signature	`cp.ui.axutils.match.emptyList(element) -> function`
Type	Function
Description	Returns a `match` function that will return true if `element` is an empty list, or has no children.
Parameters	element - The `axuielement` to check.
Returns	`true` if the element is an empty list.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 825

# exactly


Signature	`cp.ui.axutils.match.exactly(value) -> function`
Type	Function
Description	Returns a `match` function that will return true if the `axuielement` matches the provided value exactly.
Parameters	value - The value to check for.
Returns	`function(element) -> boolean` that checks the value matches exactly.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 810

# isAbove


Signature	`cp.ui.axutils.match.isAbove(value) -> function`
Type	Function
Description	Returns a `match` function that will return `true` if the `axuielement` is above the provided `value` `axuielement`.
Parameters	value - The `axuielement` to check.
Returns	A function returning `true` if the element is above the provided `value`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 884

# isBelow


Signature	`cp.ui.axutils.match.isBelow(value) -> function`
Type	Function
Description	Returns a `match` function that will return `true` if the `axuielement` is below the provided `value` `axuielement`.
Parameters	value - The `axuielement` to check.
Returns	A function returning `true` if the element is below the provided `value`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 861

# isLeftOf


Signature	`cp.ui.axutils.match.isLeftOf(value) -> function`
Type	Function
Description	Returns a `match` function that will return `true` if the `axuielement` is left of the provided `value` `axuielement`.
Parameters	value - The `axuielement` to check.
Returns	A function returning `true` if the element is left of the provided `value`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 907

# isRightOf


Signature	`cp.ui.axutils.match.isRightOf(value) -> function`
Type	Function
Description	Returns a `match` function that will return `true` if the `axuielement` is right of the provided `value` `axuielement`.
Parameters	value - The `axuielement` to check.
Returns	A function returning `true` if the element is right of the provided `value`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 930

# role


Signature	`cp.ui.axutils.match.role(roleName) -> function`
Type	Function
Description	Returns a `match` function that will return true if the `axuielement` has the specified `AXRole`.
Parameters	roleName - The role to check for.
Returns	`function(element) -> boolean` that checks the `AXRole` is `roleName`
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 795