UserStyleSetting.ColorUserStyleSetting.ColorOption
@RequiresApi(value = 34)
class UserStyleSetting.ColorUserStyleSetting.ColorOption : UserStyleSetting.Option
| kotlin.Any | ||
| ↳ | androidx.wear.watchface.style.UserStyleSetting.Option | |
| ↳ | androidx.wear.watchface.style.UserStyleSetting.ColorUserStyleSetting.ColorOption | |
Represents choice within a ColorUserStyleSetting, these must be enumerated up front.
Summary
Nested types |
|---|
|
A Builder for |
Public properties |
|
|---|---|
@ColorInt List<Int> |
The colors for this option. |
CharSequence |
Localized human readable name for the setting, used in the editor style selection UI. |
CharSequence |
Optional localized human readable name for the setting, used by screen readers. |
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. |
Inherited functions |
|---|
Inherited properties |
||||
|---|---|---|---|---|
|
Public properties
colors
val colors: @ColorInt List<Int>
The colors for this option. The colors should be listed in order of decreasing importance. The number of provided colors must be the same for all ColorOptions in the list. The number of colors specified is up to the user, but 1 or 3 are common choices.
displayName
val displayName: CharSequence
Localized human readable name for the setting, used in the editor style selection UI. This should be short (ideally < 20 characters).
screenReaderName
val screenReaderName: CharSequence
Optional localized human readable name for the setting, used by screen readers. This should be more descriptive than displayName. Note prior to android T this is ignored by companion editors.
watchFaceEditorData
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.