CommandPost Developer Guide
CommandPost Developer Guide
Download
User Guide
Facebook Group
Introduction
Getting Started
Introduction
Installation & Setup
Lua
Lua Overview
Memory Management
Contributing
Naming Conventions
CommandPost-App
CommandPost
Control CommandPost
AppleScript
URL Handler
Command Line Tool
Plugins
Plugins Overview
Internationalisation
Translating CommandPost
Final Cut Pro
Package Contents
FCPXML
Bundled Extensions
i18n
mimetypes
moses
resty
semver
slaxml
CommandPost API
cp
app
menu
prefs
commandeditor
compressor
finalcutpro
battery
bench
choices
builder
commands
command
englishKeyCodes
shortcut
config
dockIconClickCallback
fileDroppedToDockIconCallback
shutdownCallback
textDroppedToDockIconCallback
history
deferred
developer
dialog
disk
docs
feedback
font
language
languageID
localeID
region
script
idle
ids
is
json
just
lazy
localized
plist
archiver
plistParser
plugins
env
plugin
prop
protect
sourcewatcher
strings
test
text
matcher
flicks
tools
Alert
axutils
Button
CheckBox
Group
MenuButton
notifier
PopUpButton
PropertyRow
RadioButton
RadioGroup
ScrollArea
Slider
SplitGroup
StaticText
Table
TextField
Window
utf16
be
le
watcher
block
generate
html
text
ui
xml
Bundled Plugins API
plugins
Hammerspoon API
hs
Powered by GitBook

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

  • Functions - API calls offered directly by the extension

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

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

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

​

Returns

​

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

​

Returns

​

​isEnabled​

Signature

cp.ui.RadioButton:isEnabled() -> boolean

Type

Method

Description

Returns true if the radio button exists and is enabled.

Parameters

​

Returns

true or false.

​new​

Signature

cp.ui.RadioButton.new(axuielement, function) -> RadioButton

Type

Method

Description

Creates a new RadioButton.

Parameters

​

Returns

​

​parent​

Signature

cp.ui.RadioButton:parent() -> table

Type

Method

Description

The parent object.

Parameters

​

Returns

​

​press​

Signature

cp.ui.RadioButton:press() -> self

Type

Method

Description

Attempts to press the button. May fail if the UI is not available.

Parameters

​

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

​

​

​toggle​

Signature

cp.ui.RadioButton:toggle() -> self

Type

Method

Description

Toggles the checked status of the button.

Parameters

​

Returns

​

​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

​

​

Previous
PropertyRow
Next
RadioGroup
Last updated -1
Edit on GitHub
Contents
API Overview
API Documentation
Functions
Fields
Methods