UserStyleSetting.Option


abstract class UserStyleSetting.Option

Known direct subclasses
UserStyleSetting.BooleanUserStyleSetting.BooleanOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.ColorUserStyleSetting.ColorOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.ListUserStyleSetting.ListOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.


Represents a choice within a style setting which can either be an option from the list or a an arbitrary value depending on the nature of the style setting.

Summary

Nested types

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public functions

open operator Boolean
equals(other: Any?)

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

open Int

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

open String

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public properties

Collection<UserStyleSetting>

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

UserStyleSetting.Option.Id

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors

Option

Added in 1.0.0
Deprecated in 1.3.0-alpha07
Option(id: UserStyleSetting.Option.Id)

This constructor is unused (the parent class is sealed), but is required to make tooling happy.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

childSettings

Added in 1.1.0
Deprecated in 1.3.0-alpha07
val childSettingsCollection<UserStyleSetting>

The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings. These must be in UserStyleSchema.userStyleSettings. Child UserStyleSettings are deemed to be active if the Option is selected by the UserStyle. This is particularly important is there are multiple ComplicationSlotsUserStyleSettings, only one of which is allowed to be active at any time.

id

Added in 1.0.0
Deprecated in 1.3.0-alpha07
val idUserStyleSetting.Option.Id

Machine readable Id for the style setting. Identifier for the option (or the option itself for CustomValueUserStyleSetting.CustomValueOption), must be unique within the UserStyleSetting. Short ids are encouraged.