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

Represents choice within a ListUserStyleSetting, these must be enumerated up front.

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

Constructs a ListUserStyleSetting where ListUserStyleSetting.displayName and ListUserStyleSetting.description are specified as resources.
ListUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    iconProvider: () -> Icon?,
    options: List<UserStyleSetting.ListUserStyleSetting.ListOption>,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultOption: UserStyleSetting.ListUserStyleSetting.ListOption,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
)

Constructs a ListUserStyleSetting with a lazily evaluated Icon, where ListUserStyleSetting.displayName and ListUserStyleSetting.description are specified as resources.

Inherited functions
From androidx.wear.watchface.style.UserStyleSetting
open operator Boolean
equals(other: Any?)
open UserStyleSetting.Option

Translates an option name into an option.
open Int
open String

Inherited properties
From androidx.wear.watchface.style.UserStyleSetting
Collection<WatchFaceLayer>

Used by the style configuration UI.
UserStyleSetting.Option

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

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

Localized description string displayed under the displayName.
CharSequence

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

Icon for use in the companion editor style selection UI.
UserStyleSetting.Id

Identifier for the element, must be unique.
List<UserStyleSetting.Option>

List of options for this UserStyleSetting.
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.

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.

ListUserStyleSetting

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

Constructs a ListUserStyleSetting with a lazily evaluated Icon, 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.
iconProvider: () -> Icon?

A provider of an Icon for use in the companion userStyle selection UI. This gets lazily evaluated and is sent to the companion over bluetooth and should be small (ideally a few kb in size). Note this is not guaranteed to be called on the calling thread.
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.