cp.ui.RadioButton

Radio Button Module.

This represents an hs.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

Functions - API calls offered directly by the extension

matches

Fields - Variables which can only be accessed from an object returned by a constructor

checked

Methods - API calls which can only be made on an object returned by a constructor

doCheck
doLayout
doPress
doToggle
doUncheck
loadLayout
press
RadioButton
saveLayout
toggle

API Documentation

Functions

matches


Signature	`cp.ui.RadioButton.matches(element) -> boolean`
Type	Function
Description	Checks if the provided `hs.axuielement` is a RadioButton.
Parameters	element - The `axuielement` to check.
Returns	`true` if it's a match, or `false` if not.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 32

Fields

checked


Signature	`cp.ui.RadioButton.checked <cp.prop: boolean>`
Type	Field
Description	Indicates if the checkbox is currently checked. May be set by calling as a function with `true` or `false` to the function.
Notes	None
Source	src/extensions/cp/ui/RadioButton.lua line 59

Methods

doCheck


Signature	`cp.ui.RadioButton:doCheck() -> cp.rx.go.Statement`
Type	Method
Description	Returns a `Statement` that will check the button value when executed, if available at the time. If not an `error` is sent.
Parameters	None
Returns	The `Statement` which will toggle the button when executed.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 110

doLayout


Signature	`cp.ui.RadioButton:doLayout(layout) -> cp.rx.go.Statement`
Type	Method
Description	Returns a Statement that will apply the layout provided, if possible.
Parameters	layout - the `table` containing the layout configuration. Usually created via the [#saveLayout] method.
Returns	The Statement.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 202

doPress


Signature	`cp.ui.RadioButton:doPress() -> cp.rx.go.Statement`
Type	Method
Description	Returns a `Statement` that will press the button when executed, if available at the time. If not an `error` is sent.
Parameters	None
Returns	The `Statement` which will press the button when executed.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 157

doToggle


Signature	`cp.ui.RadioButton:doToggle() -> cp.rx.go.Statement`
Type	Method
Description	Returns a `Statement` that will toggle the button value when executed, if available at the time. If not an `error` is sent.
Parameters	None
Returns	The `Statement` which will toggle the button when executed.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 91

doUncheck


Signature	`cp.ui.RadioButton:doUncheck() -> cp.rx.go.Statement`
Type	Method
Description	Returns a `Statement` that will uncheck the button value when executed, if available at the time. If not an `error` is sent.
Parameters	None
Returns	The `Statement` which will toggle the button when executed.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 125

loadLayout


Signature	`cp.ui.RadioButton:loadLayout(layout) -> nil`
Type	Method
Description	Processes the `layout` table to restore this to match the provided `layout`.
Parameters	layout - the table of state values to restore to.
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 186

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.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 140

RadioButton


Signature	`cp.ui.RadioButton(axuielement, function) -> RadioButton`
Type	Method
Description	Creates a new RadioButton.
Parameters	parent - The parent object. finderFn - A function which will return the `hs.axuielement` when available.
Returns	The new `RadioButton`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 45

saveLayout


Signature	`cp.ui.RadioButton:saveLayout() -> table`
Type	Method
Description	Returns a `table` with the button's current state. This can be passed to [#loadLayout] later to restore the original state.
Parameters	None
Returns	The table of the layout state.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 171

toggle


Signature	`cp.ui.RadioButton:toggle() -> self`
Type	Method
Description	Toggles the `checked` status of the button.
Parameters	None
Returns	The `RadioButton` instance.
Notes	None
Examples	None
Source	src/extensions/cp/ui/RadioButton.lua line 77