docs » cp.ui.RadioButton


Radio Button Module.

This represents an hs._asm.axuielement with a AXRadioButton 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 RadioButton 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.RadioButton.matches(element) -> boolean
Type Function
Description Checks if the provided hs._asm.axuielement is a RadioButton.
Parameters
  • element - The axuielement to check.
Returns
  • true if it's a match, or false if not.

Fields

checked

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

isShowing

Signature cp.ui.RadioButton.isShowing <cp.prop: boolean; read-only>
Type Field
Description If true, it is visible on screen.

Methods

app

Signature cp.ui.RadioButton:app() -> table
Type Method
Description Returns the application object, via the parent().
Parameters
  • None
Returns
  • The application object.

isEnabled

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

true or false.

new

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

parent

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

press

Signature cp.ui.RadioButton:press() -> self
Type Method
Description Attempts to press the button. May fail if the UI is not available.
Parameters
  • None
Returns

The RadioButton instance.

snapshot

Signature `cp.ui.RadioButton: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.RadioButton:toggle() -> self
Type Method
Description Toggles the checked status of the button.
Parameters
  • None
Returns
  • The RadioButton instance.

UI

Signature `cp.ui.RadioButton:UI() -> hs._asm.axuielement nil` </span>
Type Method
Description Returns the axuielement representing the RadioButton, or nil if not available.
Parameters
  • None

results matching ""

    No results matching ""