UserStyleSetting.ListUserStyleSetting

open class UserStyleSetting.ListUserStyleSetting : UserStyleSetting

kotlin.Any
   ↳ androidx.wear.watchface.style.UserStyleSetting
     ↳ androidx.wear.watchface.style.UserStyleSetting.ListUserStyleSetting

A ListUserStyleSetting represents a setting with options selected from a List.

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.

Public constructors
ListUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    icon: Icon?,
    options: List<UserStyleSetting.ListUserStyleSetting.ListOption>,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultOption: UserStyleSetting.ListUserStyleSetting.ListOption,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
)

This function is deprecated. Use the Builder instead

Inherited functions
From androidx.wear.watchface.style.UserStyleSetting
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.

Inherited properties
From androidx.wear.watchface.style.UserStyleSetting
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 constructors

ListUserStyleSetting

ListUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    icon: Icon?,
    options: List<UserStyleSetting.ListUserStyleSetting.ListOption>,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultOption: UserStyleSetting.ListUserStyleSetting.ListOption = options.first(),
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)

Constructs a ListUserStyleSetting where ListUserStyleSetting.displayName and ListUserStyleSetting.description are specified as resources.

Parameters
id: UserStyleSetting.Id

Id for the element, must be unique.
resources: Resources

The Resources from which displayNameResourceId and descriptionResourceId are loaded.
displayNameResourceId: @StringRes Int

String resource id for a human readable name for the element, used in the userStyle selection UI.
descriptionResourceId: @StringRes Int

String resource id for a human readable description string displayed under the displayName.
icon: Icon?

Icon for use in the companion userStyle selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size).
options: List<UserStyleSetting.ListUserStyleSetting.ListOption>

List of all options for this ListUserStyleSetting.
affectsWatchFaceLayers: Collection<WatchFaceLayer>

Used by the style configuration UI. Describes which watch face rendering layers this style affects.
defaultOption: UserStyleSetting.ListUserStyleSetting.ListOption = options.first()

The default option, used when data isn't persisted.
watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null

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.