Check Box UI Module.
This represents an hs._asm.axuielement
with a AXCheckBox
role.
It allows checking and modifying the checked
status like so:
myButton:checked() == true -- happens to be checked already
myButton:checked(false) == false -- update to unchecked.
myButton.checked:toggle() == true -- toggled back to being checked.
You can also call instances of CheckBox
as a function, which will return
the checked
status:
myButton() == true -- still true
myButton(false) == false -- now false
Signature |
cp.ui.CheckBox.matches(element) -> boolean |
Type |
Function |
Description |
Checks if the provided hs._asm.axuielement is a CheckBox. |
Parameters |
- element - The
axuielement to check.
|
Returns |
true if it's a match, or false if not.
|
Signature |
cp.ui.CheckBox(parent, uiFinder) -> cp.ui.CheckBox |
Type |
Constructor |
Description |
Creates a new CheckBox. |
Parameters |
- parent - The parent object.
- uiFinder - A function which will return the
hs._asm.axuielement when available.
|
Returns |
|
Signature |
cp.ui.CheckBox.checked <cp.prop: boolean> |
Type |
Field |
Description |
Indicates if the checkbox is currently checked. |
Signature |
cp.ui.CheckBox.title <cp.prop: string; read-only> |
Type |
Field |
Description |
The button title, if available. |
Signature |
cp.ui.CheckBox:click() -> self |
Type |
Method |
Description |
Performs a single mouse click on the checkbox. |
Parameters |
|
Returns |
|
Signature |
cp.ui.CheckBox:doCheck() -> cp.rx.go.Statement |
Type |
Method |
Description |
Returns a Statement that will ensure the CheckBox is checked. |
Signature |
cp.ui.CheckBox:doPress() -> cp.rx.go.Statement |
Type |
Method |
Description |
Returns a Statement that will press the button when executed, if available at the time. |
Parameters |
|
Returns |
- The
Statement which will press the button when executed.
|
Signature |
cp.ui.CheckBox:doUncheck() -> cp.rx.go.Statement |
Type |
Method |
Description |
Returns a Statement that will ensure the CheckBox is unchecked. |
Signature |
cp.ui.CheckBox:loadLayout(layout) -> nil |
Type |
Method |
Description |
Applies the settings in the provided layout table. |
Parameters |
- layout - The table containing layout settings. Usually created by the
saveLayout method.
|
Returns |
|
Signature |
cp.ui.CheckBox:press() -> self |
Type |
Method |
Description |
Attempts to press the button. May fail if the UI is not available. |
Parameters |
|
Returns |
The CheckBox instance. |
Signature |
cp.ui.CheckBox:saveLayout() -> table |
Type |
Method |
Description |
Returns a table containing the layout settings for the checkbox. |
Parameters |
|
Returns |
|
Signature |
cp.ui.CheckBox:toggle() -> self |
Type |
Method |
Description |
Toggles the checked status of the button. |
Parameters |
|
Returns |
|