UserStyleSetting.BooleanUserStyleSetting

class UserStyleSetting.BooleanUserStyleSetting : UserStyleSetting

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

A BooleanUserStyleSetting represents a setting with a true and a false setting.

Summary

Nested types

Represents a true or false option in the BooleanUserStyleSetting.

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

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

Constructs a BooleanUserStyleSetting with a lazily evaluated icon, where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.description are specified as resources.

Public functions
Boolean

Returns the default value.

Inherited functions
From androidx.wear.watchface.style.UserStyleSetting
open operator Boolean
equals(other: Any?)
open UserStyleSetting.Option

Translates an option name into an option.
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

BooleanUserStyleSetting

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

Constructs a BooleanUserStyleSetting where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.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).
affectsWatchFaceLayers: Collection<WatchFaceLayer>

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

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

BooleanUserStyleSetting

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

Constructs a BooleanUserStyleSetting with a lazily evaluated icon, where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.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.
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.
affectsWatchFaceLayers: Collection<WatchFaceLayer>

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

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

getDefaultValue

Added in 1.0.0
fun getDefaultValue(): Boolean

Returns the default value.