PopUpButton

Last updated 2 months ago

Pop Up Button Module.

API Overview

API Documentation

Functions

matches

Signature

cp.ui.PopUpButton.matches(element) -> boolean

Type

Function

Description

Checks to see if an element matches what we think it should be.

Parameters

Returns

Constructors

new

Signature

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

Type

Constructor

Description

Creates a new PopUpButton.

Parameters

Returns

Methods

getValue

Signature

`cp.ui.PopUpButton:getValue() -> string

nil` </span>

Type

Method

Description

Gets the PopUpButton value.

Parameters

Returns

isEnabled

Signature

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

Type

Method

Description

Is the PopUpButton enabled?

Parameters

Returns

Signature

cp.ui.PopUpButton:loadLayout(layout) -> none

Type

Method

Description

Loads a PopUpButton layout.

Parameters

Returns

parent

Signature

cp.ui.PopUpButton:parent() -> parent

Type

Method

Description

Returns the parent object.

Parameters

Returns

press

Signature

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

Type

Method

Description

Presses the PopUpButton.

Parameters

Returns

Signature

cp.ui.PopUpButton:saveLayout() -> table

Type

Method

Description

Saves the current PopUpButton layout to a table.

Parameters

Returns

Signature

cp.ui.PopUpButton:selectItem(index) -> self

Type

Method

Description

Select an item on the PopUpButton by index.

Parameters

Returns

setValue

Signature

cp.ui.PopUpButton:setValue(value) -> self

Type

Method

Description

Sets the PopUpButton value.

Parameters

Returns

snapshot

Signature

`cp.ui.PopUpButton: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