UserStyleSetting

sealed class UserStyleSetting

Known direct subclasses
UserStyleSetting.BooleanUserStyleSetting

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

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

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

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

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

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

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

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

Watch faces often have user configurable styles, the definition of what is a style is left up to the watch face but it typically incorporates a variety of settings such as: color, visual theme for watch hands, font, tick shape, complication slots, audio elements, etc...

A UserStyleSetting represents one of these dimensions. See also UserStyleSchema which defines the list of UserStyleSettings provided by the watch face.

Styling data gets shared with the companion phone to support editors (typically over bluetooth), as a result the size of serialized UserStyleSettings could become an issue if large.

It is possible to define a hierarchy of styles, (e.g. a watch face might have support a number of different looks, each with their own settings). A hierarchy is defined by setting child styles in ListUserStyleSetting.ListOption.childSettings. A setting is deemed to be active if it's either in the top level of the tree, or if it's the child of an Option selected by the user in the UserStyle. In a hierarchy multiple ComplicationSlotsUserStyleSetting are allowed but only one can be active at any time, for more details see UserStyleSchema.findComplicationSlotsOptionForUserStyle.

use Watch Face Format instead

Summary

Nested types

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

This class 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 UserStyleSetting.Option

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<WatchFaceLayer>

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

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

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

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

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

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

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
List<UserStyleSetting.Option>

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

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

Public functions

equals

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

getOptionForId

Added in 1.0.0
Deprecated in 1.3.0-alpha06
open fun getOptionForId(optionId: UserStyleSetting.Option.Id): UserStyleSetting.Option

Translates an option name into an option. This will need to be overridden for userStyle categories that can't sensibly be fully enumerated (e.g. a full 24-bit color picker).

Parameters
optionId: UserStyleSetting.Option.Id

The Option.Id of the option
Returns
UserStyleSetting.Option

An Option corresponding to the name. This could either be one of the options from UserStyleSettings or a newly constructed Option depending on the nature of the UserStyleSetting. If optionName is unrecognized then the default value for the setting should be returned.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

affectedWatchFaceLayers

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val affectedWatchFaceLayers: Collection<WatchFaceLayer>

Used by the style configuration UI. Describes which rendering layers this style affects.

defaultOption

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val defaultOption: UserStyleSetting.Option

Returns the default for when the user hasn't selected an option.

defaultOptionIndex

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val defaultOptionIndex: Int

The default option index, used if nothing has been selected within the options list.

description

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val description: CharSequence

Localized description string displayed under the displayName.

displayName

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val displayName: CharSequence

Localized human readable name for the element, used in the userStyle selection UI.

icon

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val icon: Icon?

Icon for use in the companion editor style selection UI.

id

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val id: UserStyleSetting.Id

Identifier for the element, must be unique. Styling data gets shared with the companion (typically via bluetooth) so size is a consideration and short ids are encouraged. There is a maximum length see UserStyleSetting.Id.MAX_LENGTH.

options

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val options: List<UserStyleSetting.Option>

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).

watchFaceEditorData

Added in 1.1.0
Deprecated in 1.3.0-alpha06
val watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?

Optional data for an on watch face editor, this will not be sent to the companion and its contents may be used in preference to other fields by an on watch face editor.