#cp.ui.PopUpButton

Pop Up Button Module.

#API Overview

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

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


Signature	`cp.ui.PopUpButton.matches(element) -> boolean`
Type	Function
Description	Checks to see if an element matches what we think it should be.
Parameters	element - An `axuielementObject` to check.
Returns	`true` if matches otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 24


Signature	`cp.ui.PopUpButton(parent, uiFinder) -> cp.ui.PopUpButton`
Type	Constructor
Description	Creates a new PopUpButton.
Parameters	parent - The parent table. Should have a `isShowing` property. uiFinder - The `function` or `cp.prop` that provides the current `hs.axuielement`.
Returns	The new `PopUpButton` instance.
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 37


Signature	`cp.ui.PopUpButton.menuUI <cp.prop: hs.axuielement; read-only; live?>`
Type	Field
Description	Returns the `AXMenu` for the PopUpMenu if it is currently visible.
Notes	None
Source	src/extensions/cp/ui/PopUpButton.lua line 81


Signature	`cp.ui.PopUpButton.value <cp.prop: anything; live>`
Type	Field
Description	Returns or sets the current `PopUpButton` value.
Notes	None
Source	src/extensions/cp/ui/PopUpButton.lua line 48


Signature	`cp.ui.PopUpButton:doPress() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that presses the `PopUpButton`.
Parameters	None
Returns	The Statement
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 235


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	index - The index number of the item you want to select.
Returns	the `Statement`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 124


Signature	`cp.ui.PopUpButton:doSelectValue(value, [overrideValue]) -> cp.rx.go.Statement`
Type	Method
Description	A Statement that will select an item on the `PopUpButton` by value.
Parameters	value - The value of the item to match. overrideValue - This optional value overides the above value for the initial compare as a workaround for PopUp that have titles that don't update correctly.
Returns	the `Statement`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 152


Signature	`cp.ui.PopUpButton:getValue() -> string \| nil`
Type	Method
Description	Gets the `PopUpButton` value.
Parameters	None
Returns	The `PopUpButton` value as string, or `nil` if the value cannot be determined.
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 191


Signature	`cp.ui.PopUpButton:loadLayout(layout) -> none`
Type	Method
Description	Loads a `PopUpButton` layout.
Parameters	layout - A table containing the `PopUpButton` layout settings - created using saveLayout.
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 283


Signature	`cp.ui.PopUpButton:press() -> self`
Type	Method
Description	Presses the `PopUpButton`.
Parameters	None
Returns	self
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 218


Signature	`cp.ui.PopUpButton:saveLayout() -> table`
Type	Method
Description	Saves the current `PopUpButton` layout to a table.
Parameters	None
Returns	A table containing the current `PopUpButton` Layout.
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 268


Signature	`cp.ui.PopUpButton:selectItem(index) -> self`
Type	Method
Description	Select an item on the `PopUpButton` by index.
Parameters	index - The index of the item you want to select.
Returns	self
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 97


Signature	`cp.ui.PopUpButton:setValue(value) -> self`
Type	Method
Description	Sets the `PopUpButton` value.
Parameters	value - The value you want to set the `PopUpButton` to.
Returns	self
Notes	None
Examples	None
Source	src/extensions/cp/ui/PopUpButton.lua line 204