UserStyleSetting.LongRangeUserStyleSetting

class UserStyleSetting.LongRangeUserStyleSetting : UserStyleSetting

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

A LongRangeUserStyleSetting represents a setting with a Long value in the range minimumValue .. maximumValue.

Summary

Nested types

Represents an option a Long in the range minimumValue .. maximumValue.

Public constructors
LongRangeUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    icon: Icon?,
    minimumValue: Long,
    maximumValue: Long,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: Long,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
)

Constructs a LongRangeUserStyleSetting where LongRangeUserStyleSetting.displayName and LongRangeUserStyleSetting.description are specified as resources.
LongRangeUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    iconProvider: () -> Icon?,
    minimumValue: Long,
    maximumValue: Long,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: Long,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
)

Constructs a LongRangeUserStyleSetting where LongRangeUserStyleSetting.displayName and LongRangeUserStyleSetting.description are specified as resources, with a lazily constructed icon.

Public functions
open UserStyleSetting.Option

We support all values in the range min ... max not just min & max.

Public properties
Long

The default value.
Long

The maximum value.
Long

The minimum value.

Inherited functions
From androidx.wear.watchface.style.UserStyleSetting
open operator Boolean
equals(other: Any?)
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

LongRangeUserStyleSetting

LongRangeUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    icon: Icon?,
    minimumValue: Long,
    maximumValue: Long,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: Long,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)

Constructs a LongRangeUserStyleSetting where LongRangeUserStyleSetting.displayName and LongRangeUserStyleSetting.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).
minimumValue: Long

Minimum value (inclusive).
maximumValue: Long

Maximum value (inclusive).
affectsWatchFaceLayers: Collection<WatchFaceLayer>

Used by the style configuration UI. Describes which watch face rendering layers this style affects.
defaultValue: Long

The default value for this LongRangeUserStyleSetting.
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.

LongRangeUserStyleSetting

LongRangeUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    iconProvider: () -> Icon?,
    minimumValue: Long,
    maximumValue: Long,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: Long,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)

Constructs a LongRangeUserStyleSetting where LongRangeUserStyleSetting.displayName and LongRangeUserStyleSetting.description are specified as resources, with a lazily constructed icon.

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.
minimumValue: Long

Minimum value (inclusive).
maximumValue: Long

Maximum value (inclusive).
affectsWatchFaceLayers: Collection<WatchFaceLayer>

Used by the style configuration UI. Describes which watch face rendering layers this style affects.
defaultValue: Long

The default value for this LongRangeUserStyleSetting.
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.

Public functions

getOptionForId

open fun getOptionForId(optionId: UserStyleSetting.Option.Id): UserStyleSetting.Option

We support all values in the range min ... max not just min & max.

Public properties

defaultValue

Added in 1.0.0
val defaultValue: Long

The default value.

maximumValue

Added in 1.0.0
val maximumValue: Long

The maximum value.

minimumValue

Added in 1.0.0
val minimumValue: Long

The minimum value.