BooleanUserStyleSetting
class BooleanUserStyleSetting : UserStyleSetting
A BooleanUserStyleSetting represents a setting with a true and a false setting.
Summary
Public methods |
Boolean |
Returns the default value.
|
BooleanUserStyleSettingWireFormat |
|
Inherited properties |
From class UserStyleSetting
Collection<Layer> |
affectsLayers
Used by the style configuration UI. Describes which rendering layers this style affects.
|
Int |
defaultOptionIndex
The default option index, used if nothing has been selected within the options list.
|
CharSequence |
description
Localized description string displayed under the displayName.
|
CharSequence |
displayName
Localized human readable name for the element, used in the userStyle selection UI.
|
Icon? |
icon
Icon for use in the style selection UI.
|
String |
id
Identifier for the element, must be unique.
|
List<UserStyleSetting.Option> |
options
List of options for this UserStyleSetting. Depending on the type of UserStyleSetting this
may be an exhaustive list, or just examples to populate a ListView in case the
UserStyleSetting isn't supported by the UI (e.g. a new WatchFace with an old Companion).
|
|
Public constructors
Public methods
getDefaultValue
fun getDefaultValue(): Boolean
Returns the default value.
fun toWireFormat(): BooleanUserStyleSettingWireFormat