Internationalisation
Bundled Plugins API
CheckBox
Check Box UI Module.
This represents an hs._asm.axuielement with a AXCheckBox role. It allows checking and modifying the checked status like so:
1
myButton:checked() == true -- happens to be checked already
2
myButton:checked(false) == false -- update to unchecked.
3
myButton.checked:toggle() == true -- toggled back to being checked.
Copied!
You can also call instances of CheckBox as a function, which will return the checked status:
1
myButton() == true -- still true
2
myButton(false) == false -- now false
Copied!

API Overview

  • Functions - API calls offered directly by the extension
  • matches
  • Constructors - API calls which return an object, typically one that offers API methods
  • CheckBox
  • Fields - Variables which can only be accessed from an object returned by a constructor
  • checked
  • title
  • Methods - API calls which can only be made on an object returned by a constructor
  • click
  • doCheck
  • doPress
  • doUncheck
  • press
  • toggle

API Documentation

Functions

matches

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.

Constructors

CheckBox

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
  • The new CheckBox.

Fields

checked

Signature
cp.ui.CheckBox.checked <cp.prop: boolean>
Type
Field
Description
Indicates if the checkbox is currently checked.

title

Signature
cp.ui.CheckBox.title <cp.prop: string; read-only>
Type
Field
Description
The button title, if available.

Methods

click

Signature
cp.ui.CheckBox:click() -> self
Type
Method
Description
Performs a single mouse click on the checkbox.
Parameters
  • None
Returns
  • The CheckBox instance.

doCheck

Signature
cp.ui.CheckBox:doCheck() -> cp.rx.go.Statement
Type
Method
Description
Returns a Statement that will ensure the CheckBox is checked.

doPress

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
  • None
Returns
  • The Statement which will press the button when executed.

doUncheck

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
  • nil

press

Signature
cp.ui.CheckBox:press() -> self
Type
Method
Description
Attempts to press the button. May fail if the UI is not available.
Parameters
  • None
Returns
The CheckBox instance.
Signature
cp.ui.CheckBox:saveLayout() -> table
Type
Method
Description
Returns a table containing the layout settings for the checkbox.
Parameters
  • None
Returns
  • A settings table.

toggle

Signature
cp.ui.CheckBox:toggle() -> self
Type
Method
Description
Toggles the checked status of the button.
Parameters
  • None
Returns
  • The CheckBox instance.
Last modified 1mo ago