UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay
class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay
Overrides to be applied to the corresponding androidx.wear.watchface.ComplicationSlot's initial config (as specified in it's constructor) when the setting is selected.
Summary
Nested types |
|---|
|
Constructs a |
Public constructors |
|---|
This function is deprecated. This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId |
ComplicationSlotOverlay( |
Public properties |
|
|---|---|
Int? |
If non null the accessibility traversal index for this configuration. |
ComplicationSlotBounds? |
If non null, the |
Int |
The id of the |
Boolean? |
If non null, whether the complication should be enabled for this configuration. |
Int? |
If non null, the string resource identifier for name of the complication slot, for this configuration. |
Int? |
If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. |
Public constructors
ComplicationSlotOverlay(
complicationSlotId: Int,
enabled: Boolean? = null,
complicationSlotBounds: ComplicationSlotBounds? = null,
accessibilityTraversalIndex: Int? = null
)
This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId ComplicationSlotOverlay(Int, Boolean?, ComplicationSlotBounds?, Int?, Int?, Int?
ComplicationSlotOverlay
ComplicationSlotOverlay(
complicationSlotId: Int,
enabled: Boolean? = null,
complicationSlotBounds: ComplicationSlotBounds? = null,
accessibilityTraversalIndex: Int? = null,
nameResourceId: Int? = null,
screenReaderNameResourceId: Int? = null
)
| Parameters | |
|---|---|
complicationSlotId: Int |
The id of the |
enabled: Boolean? = null |
If non null, whether the complication should be enabled for this configuration. If null then no changes are made. |
complicationSlotBounds: ComplicationSlotBounds? = null |
If non null, the |
accessibilityTraversalIndex: Int? = null |
If non null the accessibility traversal index for this configuration. This is used to determine the order in which accessibility labels for the watch face are read to the user. |
nameResourceId: Int? = null |
If non null, the string resource identifier for name of the complication slot, for this configuration. These strings should be short (perhaps 10 characters max) E.g. complication slots named 'left' and 'right' might be shown by the editor in a list from which the user selects a complication slot for editing. |
screenReaderNameResourceId: Int? = null |
If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. While similar to |
Public functions
Public properties
accessibilityTraversalIndex
val accessibilityTraversalIndex: Int?
If non null the accessibility traversal index for this configuration. This is used to determine the order in which accessibility labels for the watch face are read to the user.
complicationSlotBounds
val complicationSlotBounds: ComplicationSlotBounds?
If non null, the ComplicationSlotBounds for this configuration. If null then no changes are made.
complicationSlotId
val complicationSlotId: Int
The id of the androidx.wear.watchface.ComplicationSlot to configure.
enabled
val enabled: Boolean?
If non null, whether the complication should be enabled for this configuration. If null then no changes are made.
nameResourceId
val nameResourceId: Int?
If non null, the string resource identifier for name of the complication slot, for this configuration. These strings should be short (perhaps 10 characters max) E.g. complication slots named 'left' and 'right' might be shown by the editor in a list from which the user selects a complication slot for editing.
screenReaderNameResourceId
val screenReaderNameResourceId: Int?
If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. While similar to nameResourceId this string can be longer and should be more descriptive. E.g. saying 'left complication' rather than just 'left'.