OptionalRangePreference

A Preference whose values must be null or in a ClosedRange of T.

Properties

abstract val effectiveValue: T?

The value that will be effectively used by the navigator if preferences are submitted as they are.

If this preference will be effectively used by the navigator if preferences are submitted as they are.

abstract val value: T?

The current value of the preference.

Unset the preference.

abstract fun decrement()

Decrement the preference value from its current value or a default value.

Returns a new preference with its boolean value flipped.

abstract fun formatValue(value: T): String

Format value in a way suitable for display, including unit if relevant.

abstract fun increment()

Increment the preference value from its current value or a default value.

fun <T, V> Preference<T>.map(from: (T) -> V, to: (V) -> T): Preference<V>

Creates a new Preference object wrapping the receiver and converting its value from and to the target type V.

abstract fun set(value: T?)

Set the preference to value. A null value means unsetting the preference.

Toggle the preference value. A default value is taken as the initial one if the preference is currently unset.

Creates a new EnumPreference object wrapping the receiver with the provided supportedValues.