docs » cp.ui.PopUpButton
Pop Up Button Module.
- Functions - API calls offered directly by the extension
- matches
- Constructors - API calls which return an object, typically one that offers API methods
- PopUpButton
- Fields - Variables which can only be accessed from an object returned by a constructor
- menuUI
- value
- Methods - API calls which can only be made on an object returned by a constructor
- doPress
- doSelectItem
- doSelectValue
- getValue
- loadLayout
- press
- saveLayout
- selectItem
- setValue
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 |
|
Signature | cp.ui.PopUpButton(parent, uiFinder) -> cp.ui.PopUpButton |
---|---|
Type | Constructor |
Description | Creates a new PopUpButton. |
Parameters |
|
Returns |
|
Signature | cp.ui.PopUpButton.menuUI <cp.prop: hs._asm.axuielement; read-only; live?> |
---|---|
Type | Field |
Description | Returns the AXMenu for the PopUpMenu if it is currently visible. |
Signature | cp.ui.PopUpButton.value <cp.prop: anything; live> |
---|---|
Type | Field |
Description | Returns or sets the current PopUpButton value. |
Signature | cp.ui.PopUpButton:doPress() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that presses the PopUpButton . |
Parameters |
|
Returns |
|
Signature | cp.ui.PopUpButton:doSelectItem(index) -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that will select an item on the PopUpButton by index. |
Parameters |
|
Returns |
|
Signature | cp.ui.PopUpButton:doSelectValue(value) -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that will select an item on the PopUpButton by value. |
Parameters |
|
Returns |
|
| Signature | cp.ui.PopUpButton:getValue() -> string | nil
|
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| Type | Method |
| Description | Gets the PopUpButton
value. |
| Parameters |
- None
- The
PopUpButton
value as string, ornil
if the value cannot be determined.
Signature | cp.ui.PopUpButton:loadLayout(layout) -> none |
---|---|
Type | Method |
Description | Loads a PopUpButton layout. |
Parameters |
|
Returns |
|
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 |
|
Signature | cp.ui.PopUpButton:setValue(value) -> self |
---|---|
Type | Method |
Description | Sets the PopUpButton value. |
Parameters |
|
Returns |
|