class EnumPreferenceDelegate<T>(getValue: () -> T?, getEffectiveValue: () -> T, getIsEffective: () -> Boolean, updateValue: (T?) -> Unit, val supportedValues: List<T>) : PreferenceDelegate<T> , EnumPreference<T>

Fit

@Serializable

enum Fit : Enum<Fit>

Method for constraining a resource inside the viewport.

FontFamily

@JvmInline

@Serializable

value class FontFamily(val name: String)

Typeface for a publication's text.

ImageFilter

@Serializable

enum ImageFilter : Enum<ImageFilter>

IntIncrement

class IntIncrement(increment: Int) : ProgressionStrategy<Int>

Simple progression strategy which increments or decrements the setting by a fixed number.

OptionalRangePreference

interface OptionalRangePreference<T : Comparable<T>> : Preference<T?>

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

OptionalRangePreferenceDelegate

class OptionalRangePreferenceDelegate<T : Comparable<T>>(getValue: () -> T?, getEffectiveValue: () -> T?, getIsEffective: () -> Boolean, updateValue: (T?) -> Unit, defaultValue: T, valueFormatter: (T) -> String, val supportedRange: ClosedRange<T>, progressionStrategy: ProgressionStrategy<T>) : PreferenceDelegate<T?> , OptionalRangePreference<T>

Preference

interface Preference<T>

A handle to edit the value of a specific preference which is able to predict which value the Configurable will effectively use.

PreferenceDelegate

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

PreferencesEditor

interface PreferencesEditor>

Interactive editor of preferences.

PreferencesFilter

fun interface PreferencesFilter>

A filter to keep only some preferences and filter out some others.

PreferencesSerializer

interface PreferencesSerializer>

JSON serializer of P.

ProgressionStrategy

interface ProgressionStrategy<V>

A strategy to increment or decrement a setting.

RangePreference

interface RangePreference<T : Comparable<T>> : Preference<T>

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

RangePreferenceDelegate

class RangePreferenceDelegate<T : Comparable<T>>(getValue: () -> T?, getEffectiveValue: () -> T, getIsEffective: () -> Boolean, updateValue: (T?) -> Unit, valueFormatter: (T) -> String, val supportedRange: ClosedRange<T>, progressionStrategy: ProgressionStrategy<T>) : PreferenceDelegate<T> , RangePreference<T>

ReadingProgression

@Serializable

enum ReadingProgression : Enum<ReadingProgression>

Direction of the reading progression across resources.

Spread

@Serializable

enum Spread : Enum<Spread>

Synthetic spread policy.

StepsProgression

class StepsProgression<T : Comparable<T>>(steps: List<T>, equalsDelta: (T, T) -> Boolean) : ProgressionStrategy<T>

Progression strategy based on a list of preferred values for the setting.

TextAlign

@Serializable

enum TextAlign : Enum<TextAlign>

Theme

@Serializable

enum Theme : Enum<Theme>

Functions

clear

fun <T> Preference<T>.clear()

Unset the preference.

flipped

fun Preference<Boolean>.flipped(): Preference<Boolean>

Returns a new preference with its boolean value flipped.

map

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.

fun <T, V> EnumPreference<T>.map(from: (T) -> V, to: (V) -> T, supportedValues: (List<T>) -> List<V> = { it.map(from) }): EnumPreference<V>

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

fun <T : Comparable<T>> RangePreference<T>.map(supportedRange: (ClosedRange<T>) -> ClosedRange<T> = { it }, formatValue: (T) -> String? = null, increment: RangePreference<T>.() -> Unit? = null, decrement: RangePreference<T>.() -> Unit? = null): RangePreference<T>

Creates a new RangePreference object wrapping the receiver and transforming its supportedRange, or overwriting its formatValue or increment and decrement strategy.

fun <T : Comparable<T>, V : Comparable<V>> RangePreference<T>.map(from: (T) -> V, to: (V) -> T, supportedRange: (ClosedRange<T>) -> ClosedRange<V> = { from(it.start)..from(it.endInclusive) }, formatValue: (V) -> String? = null, increment: RangePreference<V>.() -> Unit? = null, decrement: RangePreference<V>.() -> Unit? = null): RangePreference<V>

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

mapSupportedValues

fun <T> EnumPreference<T>.mapSupportedValues(transform: (List<T>) -> List<T>): EnumPreference<T>

Creates a new EnumPreference object wrapping the receiver and transforming its supported values with transform.

plus

operator fun > PreferencesFilter.plus(other: PreferencesFilter): PreferencesFilter

toggle

fun Preference<Boolean>.toggle()

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

withSupportedRange

fun <T : Comparable<T>> RangePreference<T>.withSupportedRange(range: ClosedRange<T> = supportedRange, progressionStrategy: ProgressionStrategy<T>): RangePreference<T>

Creates a new RangePreference object wrapping the receiver and using a different supported range. A new progressionStrategy can be provided to customize the implementation of increment and decrement.

withSupportedValues

fun <T> EnumPreference<T>.withSupportedValues(vararg supportedValues: T): EnumPreference<T>

fun <T> EnumPreference<T>.withSupportedValues(supportedValues: List<T>): EnumPreference<T>

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.