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 |
|---|
|
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 |
|---|
This function is deprecated. Use the Builder instead |
Public functions |
|
|---|---|
open UserStyleSetting.Option |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public properties |
|
|---|---|
Long |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Long |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Long |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Inherited functions |
||||||
|---|---|---|---|---|---|---|
|
Inherited properties |
||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 |
|
resources: Resources |
The |
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? |
|
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 fungetOptionForId(optionId: UserStyleSetting.Option.Id): UserStyleSetting.Option
We support all values in the range min ... max not just min & max.