#cp.choices.builder

Choices Builder Module.

#API Overview

Functions - API calls offered directly by the extension

new

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

id
image
params
subText
text

#API Documentation

#Functions

#new


Signature	`cp.choices.builder.new(choiceType) -> builder`
Type	Function
Description	Creates a new choice builder instance.
Parameters	`choice` - The choice instance to configure.
Returns	The new choice builder.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 7

#Methods

#id


Signature	`cp.choices.builder:id(value) -> builder`
Type	Method
Description	Sets the ID of the choice.
Parameters	`value` - The ID.
Returns	The choice builder.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 53

#image


Signature	`cp.choices.builder:image(value) -> builder`
Type	Method
Description	Sets the image of the choice.
Parameters	value - A `hs.image` image object that will be displayed next to the choice
Returns	The choice builder.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 67

#params


Signature	`cp.choices.builder:params(value) -> builder`
Type	Method
Description	Specifies a table of parameter values for the choice. These values need to be simple - text, numbers, booleans, or tables.
Parameters	`value` - The table of parameters.
Returns	The choice builder, added to the choices set.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 83

#subText


Signature	`cp.choices.builder:subText(value) -> builder`
Type	Method
Description	Specifies the `subText` value for the choice being built.
Parameters	`value` - The subText title for the choice.
Returns	The choice builder.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 39

#text


Signature	`cp.choices.builder:text(value) -> builder`
Type	Method
Description	Specifies the text value for the choice being built.
Parameters	`value` - The text title for the choice.
Returns	The choice builder, added to the choices set.
Notes	None
Examples	None
Source	src/extensions/cp/choices/init.lua line 25