UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption

class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption : UserStyleSetting.Option

kotlin.Any
   ↳ androidx.wear.watchface.style.UserStyleSetting.Option
     ↳ androidx.wear.watchface.style.UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption

Represents an override to the initial androidx.wear.watchface.ComplicationSlotsManager configuration.

Summary

Public constructors
ComplicationSlotsOption(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    icon: Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
)

This function is deprecated. Use a constructor that sets the screenReaderNameResourceId
ComplicationSlotsOption(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    screenReaderNameResourceId: @StringRes Int,
    icon: Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
)

Constructs a ComplicationSlotsUserStyleSetting with displayName constructed from Resources.
ComplicationSlotsOption(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    screenReaderNameResourceId: @StringRes Int,
    iconProvider: () -> Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
)

Constructs a ComplicationSlotsUserStyleSetting with a lazily evaluated icon, where displayName is constructed from Resources.

Public properties
Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>

Overlays to be applied when this ComplicationSlotsOption is selected.
CharSequence

Localized human readable name for the setting, used in the editor style selection UI.
Icon?

Icon for use in the companion 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
From androidx.wear.watchface.style.UserStyleSetting.Option
open operator Boolean
equals(other: Any?)
open Int
open String

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

The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings.
UserStyleSetting.Option.Id

Machine readable Id for the style setting.

Public constructors

ComplicationSlotsOption

Added in 1.1.0
Deprecated in 1.2.0
ComplicationSlotsOption(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    icon: Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)

Constructs a ComplicationSlotsUserStyleSetting with displayName constructed from Resources.

Parameters
id: UserStyleSetting.Option.Id

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

The Resources from which displayNameResourceId is load.
displayNameResourceId: @StringRes Int

String resource id for a human readable name for the element, used in the userStyle selection UI. This should be short, ideally < 20 characters. Note if the resource string contains %1$s that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions.
icon: Icon?

Icon for use in the companion style selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size).
complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>

Overlays to be applied when this ComplicationSlotsOption is selected. If this is empty then the net result is the initial complication configuration.
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.

ComplicationSlotsOption

Added in 1.2.0
ComplicationSlotsOption(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    screenReaderNameResourceId: @StringRes Int,
    icon: Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)

Constructs a ComplicationSlotsUserStyleSetting with displayName constructed from Resources.

Parameters
id: UserStyleSetting.Option.Id

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

The Resources from which displayNameResourceId is load.
displayNameResourceId: @StringRes Int

String resource id for a human readable name for the element, used in the userStyle selection UI. This should be short, ideally < 20 characters. Note if the resource string contains %1$s that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions.
screenReaderNameResourceId: @StringRes Int

String resource id for a human readable name for the element, used by screen readers. This should be more descriptive than displayNameResourceId. Note if the resource string contains %1$s that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions. Note prior to android T this is ignored by companion editors.
icon: Icon?

Icon for use in the companion style selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size).
complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>

Overlays to be applied when this ComplicationSlotsOption is selected. If this is empty then the net result is the initial complication configuration.
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.

ComplicationSlotsOption

Added in 1.3.0-alpha04
ComplicationSlotsOption(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    screenReaderNameResourceId: @StringRes Int,
    iconProvider: () -> Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)

Constructs a ComplicationSlotsUserStyleSetting with a lazily evaluated icon, where displayName is constructed from Resources.

Parameters
id: UserStyleSetting.Option.Id

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

The Resources from which displayNameResourceId is load.
displayNameResourceId: @StringRes Int

String resource id for a human readable name for the element, used in the userStyle selection UI. This should be short, ideally < 20 characters. Note if the resource string contains %1$s that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions.
screenReaderNameResourceId: @StringRes Int

String resource id for a human readable name for the element, used by screen readers. This should be more descriptive than displayNameResourceId. Note if the resource string contains %1$s that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions. Note prior to android T this is ignored by companion editors.
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.
complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>

Overlays to be applied when this ComplicationSlotsOption is selected. If this is empty then the net result is the initial complication configuration.
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 properties

complicationSlotOverlays

Added in 1.0.0
val complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>

Overlays to be applied when this ComplicationSlotsOption is selected. If this is empty then the net result is the initial complication configuration.

displayName

Added in 1.0.0
val displayName: CharSequence

Localized human readable name for the setting, used in the editor style selection UI. This should be short (ideally < 20 characters).

icon

Added in 1.0.0
val icon: Icon?

Icon for use in the companion style selection UI.

screenReaderName

Added in 1.2.0
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

Added in 1.1.0
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.