docs » cp.ui.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:

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

API Overview

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

new

Signature cp.ui.CheckBox.new(axuielement, function) -> cp.ui.CheckBox
Type Constructor
Description Creates a new CheckBox.
Parameters
  • * parent - The parent object.
  • * finderFn - A function which will return the `hs._asm.axuielement` when available.
Returns
  • * The new `CheckBox`.

Methods

isEnabled

Signature cp.ui.CheckBox:isEnabled() -> boolean
Type Method
Description Returns true if the radio button exists and is enabled.
Parameters
  • * None
Returns
  • `true` or `false`.

loadLayout

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

parent

Signature cp.ui.CheckBox:parent() -> table
Type Method
Description The parent object.
Parameters
  • * None
Returns
  • * The parent object.

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.

saveLayout

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.

snapshot

Signature `cp.ui.CheckBox:snapshot([path]) -> hs.image nil` </span>
Type Method
Description Takes a snapshot of the UI in its current state as a PNG and returns it.
Parameters
  • * path - (optional) The path to save the file. Should include the extension (should be `.png`).

toggle

Signature cp.ui.CheckBox:toggle() -> self
Type Method
Description Toggles the checked status of the button.
Parameters
  • * None
Returns
  • * The `CheckBox` instance.

results matching ""

    No results matching ""