PreferenceDelegate

open class PreferenceDelegate<T>(getValue: () -> T?, getEffectiveValue: () -> T, getIsEffective: () -> Boolean, updateValue: (T?) -> Unit) : Preference<T>

Inheritors

Constructors

Link copied to clipboard
constructor(getValue: () -> T?, getEffectiveValue: () -> T, getIsEffective: () -> Boolean, updateValue: (T?) -> Unit)

Properties

Link copied to clipboard
open override val effectiveValue: T

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

Link copied to clipboard
open override val isEffective: Boolean

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

Link copied to clipboard
open override val value: T?

The current value of the preference.

Functions

Link copied to clipboard
fun <T> Preference<T>.clear()

Unset the preference.

Link copied to clipboard

Returns a new preference with its boolean value flipped.

Link copied to clipboard
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.

Link copied to clipboard
open override fun set(value: T?)

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

Link copied to clipboard

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

Link copied to clipboard
fun <T> Preference<T>.withSupportedValues(vararg supportedValues: T): EnumPreference<T>
fun <T> Preference<T>.withSupportedValues(supportedValues: List<T>): EnumPreference<T>

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