renetik-android-preset/renetik.android.preset

Package-level declarations

CSPreset and its property factories, plus Preset.init() and the save/reload lifecycle (saveAsCurrent, reloadInternal).

Types

CSPreset

class CSPreset<PresetListItem : CSPresetItem, PresetList : CSPresetItemList<PresetListItem>>(parent: CSHasDestruct, val parentStore: CSStore, key: String, val list: PresetList, notFoundItem: (CSStore) -> PresetListItem, defaultItemId: String? = null) : CSModel, CSHasChange<Unit>

CSPresetItem

interface CSPresetItem : CSHasId

CSPresetItemList

interface CSPresetItemList<PresetItem : CSPresetItem> : CSHasId, Collection<PresetItem>

CSPresetListItem

class CSPresetListItem<PresetItem : CSPresetItem, PresetList : CSPresetItemList<PresetItem>>(val preset: CSPreset<PresetItem, PresetList>, notFoundPresetItem: (CSStore) -> PresetItem, defaultItemId: String? = null) : CSPropertyWrapper<PresetItem> , CSPresetKeyData

CSPresetStore

class CSPresetStore(val preset: CSPreset<*, *>) : CSJsonObjectStore, CSPresetKeyData

Preset

typealias Preset = CSPreset<*, out CSPresetItemList<*>>

Functions

action

inline fun <T, V : CSHasChangeValue<T>> V.action(preset: Preset, crossinline function: (T) -> Unit): CSRegistration

fun <T : Preset> T.action(parent: CSHasRegistrations, hasChange: CSHasChange<*>, onChange: Fun): CSRegistration

actionPausedBy

fun <T> CSHasChangeValue<T>.actionPausedBy(preset: CSPreset<*, *>, function: (T) -> Unit): CSRegistration

fun CSHasChange<*>.actionPausedBy(preset: CSPreset<*, *>, function: () -> Unit): CSRegistration

followStoreIf

fun <T : Preset> T.followStoreIf(property: CSProperty<Boolean>): CSRegistration

init

fun <PresetListItem : CSPresetItem, PresetList : CSPresetItemList<PresetListItem>, Preset : CSPreset<PresetListItem, PresetList>> Preset.init(): Preset

isModified

fun Preset.isModified(parent: CSHasRegistrationsHasDestruct): CSHasChangeValue<Boolean>

itemTitle

fun Preset.itemTitle(parent: CSHasRegistrationsHasDestruct, withModified: Boolean = false, process: (String) -> String = { it }): CSHasChangeValue<String>

itemTitleWithModified

fun Preset.itemTitleWithModified(isModified: CSHasChangeValue<Boolean>, process: (String) -> String = { it }): CSHasChangeValue<String>

fun Preset.itemTitleWithModified(parent: CSHasRegistrationsHasDestruct, process: (String) -> String = { it }): CSHasChangeValue<String>

nullArrayItemProperty

fun <T> Preset.nullArrayItemProperty(parent: CSHasRegistrationsHasDestruct, key: String, values: Array<T>, default: T? = null, onChange: (value: T?) -> Unit? = null): CSListItemNullablePresetProperty<T?>

nullBoolProperty

fun Preset.nullBoolProperty(parent: CSHasRegistrationsHasDestruct, key: String, default: Boolean? = null, onChange: ArgFun<Boolean?>? = null): CSBooleanNullablePresetProperty

nullDoubleProperty

fun Preset.nullDoubleProperty(parent: CSHasRegistrationsHasDestruct, key: String, default: Double? = null, onChange: (value: Double?) -> Unit? = null): CSDoubleNullablePresetProperty

nullFloatProperty

fun Preset.nullFloatProperty(parent: CSHasRegistrationsHasDestruct, key: String, default: Float? = null, onChange: (value: Float?) -> Unit? = null): CSFloatNullablePresetProperty

nullIntProperty

fun Preset.nullIntProperty(parent: CSHasRegistrationsHasDestruct, key: String, default: Int? = null, onChange: (value: Int?) -> Unit? = null): CSIntNullablePresetProperty

nullListItemProperty

fun <T> Preset.nullListItemProperty(parent: CSHasRegistrationsHasDestruct, key: String, getValues: () -> List<T>, default: T? = null, onChange: (value: T?) -> Unit? = null): CSListItemNullablePresetProperty<T?>

fun <T> Preset.nullListItemProperty(parent: CSHasRegistrationsHasDestruct, key: String, values: List<T>, default: T? = null, onChange: (value: T?) -> Unit? = null): CSListItemNullablePresetProperty<T?>

nullStringProperty

fun Preset.nullStringProperty(parent: CSHasRegistrationsHasDestruct, key: String, default: String? = null, onChange: (value: String?) -> Unit? = null): CSStringNullablePresetProperty

onChange

fun <T : Preset> T.onChange(before: Fun, onChange: Fun): CSRegistration

inline fun CSHasChange<*>.onChange(preset: Preset, crossinline function: Fun): CSRegistration

fun <T : Preset> T.onChange(paused: List<CSRegistration>, before: Fun = {}, onChange: Fun): CSRegistration

fun <T : Preset> T.onChange(parent: CSHasRegistrations, hasChange: CSHasChange<*>, onChange: Fun): CSRegistration

fun <T : Preset> T.onChange(paused: CSRegistration, before: Fun = {}, onChange: Fun): CSRegistration

onChangeLater

inline fun <T : CSHasChange<*>> List<T>.onChangeLater(preset: Preset, crossinline function: Fun): CSRegistration

onChangePausedBy

fun <T> CSHasChangeValue<T>.onChangePausedBy(preset: CSPreset<*, *>, function: (T) -> Unit): CSRegistration

fun CSHasChange<*>.onChangePausedBy(preset: CSPreset<*, *>, function: () -> Unit): CSRegistration

onReloadPause

fun <T : Preset> T.onReloadPause(vararg properties: CSProperty<*>): CSRegistration

fun <T : Preset> T.onReloadPause(vararg registrations: CSRegistration): CSRegistration

paused

fun <T : Preset> T.paused(vararg registrations: CSRegistration, onChange: Fun): CSRegistration

property

inline fun <T : CSJsonObjectStore> Preset.property(parent: CSHasDestruct, key: String, noinline onChange: ArgFun<T>? = null): CSPresetProperty<T>

fun Preset.property(parent: CSHasDestruct, key: String, default: Boolean, onChange: ArgFun<Boolean>? = null): CSBooleanValuePresetProperty

fun Preset.property(parent: CSHasDestruct, key: String, default: Double, onChange: ArgFun<Double>? = null): CSDoubleValuePresetProperty

fun Preset.property(parent: CSHasDestruct, key: String, default: Float, onChange: ArgFun<Float>? = null): CSFloatValuePresetProperty

fun Preset.property(parent: CSHasDestruct, key: String, default: () -> Int, onChange: ArgFun<Int>? = null): CSIntValuePresetProperty

fun Preset.property(parent: CSHasDestruct, key: String, getDefault: () -> String, onChange: ArgFun<String>? = null): CSStringValuePresetProperty

fun Preset.property(parent: CSHasDestruct, key: String, default: Int, onChange: ArgFun<Int>? = null): CSIntValuePresetProperty

fun Preset.property(parent: CSHasDestruct, key: String, default: String, onChange: ArgFun<String>? = null): CSStringValuePresetProperty

inline fun <T : CSJsonObjectStore> Preset.property(parent: CSHasDestruct, key: String, default: List<T> = emptyList(), noinline onChange: ArgFun<List<T>>? = null): CSPresetProperty<List<T>>

fun Preset.property(parent: CSHasDestruct, key: String, default: List<Int>, onChange: ArgFun<List<Int>>? = null): CSIntListValuePresetProperty

@JvmName(name = "propertyMutableList")

inline fun <T : CSJsonObjectStore> Preset.property(parent: CSHasDestruct, key: String, default: MutableList<T> = mutableListOf(), noinline onChange: ArgFun<MutableList<T>>? = null): CSPresetProperty<MutableList<T>>

fun <T : CSJsonObjectStore> Preset.property(parent: CSHasDestruct, key: String, type: KClass<T>, onChange: ArgFun<T>? = null): CSPresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, values: Array<T>, default: T, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, values: Array<T>, defaultIndex: Int, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T : CSHasId> Preset.property(parent: CSHasDestruct, key: String, values: Array<T>, default: List<T> = emptyList(), onChange: ArgFun<List<T>>? = null): CSHasIdListValuePresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, values: () -> Collection<T>, getDefault: () -> T, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, getValues: () -> List<T>, default: T, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, getValues: () -> List<T>, defaultIndex: Int, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, values: List<T>, default: T, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, values: List<T>, getDefault: () -> T, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T> Preset.property(parent: CSHasDestruct, key: String, values: List<T>, defaultIndex: Int, onChange: ArgFun<T>? = null): CSListItemValuePresetProperty<T>

fun <T : CSHasId> Preset.property(parent: CSHasDestruct, key: String, values: List<T>, default: List<T> = emptyList(), onChange: ArgFun<List<T>>? = null): CSHasIdListValuePresetProperty<T>

fun <T : CSJsonObjectStore> Preset.property(parent: CSHasDestruct, key: String, listType: KClass<T>, default: List<T> = emptyList(), onChange: ArgFun<List<T>>? = null): CSPresetProperty<List<T>>

@JvmName(name = "propertyMutableList")

fun <T : CSJsonObjectStore> Preset.property(parent: CSHasDestruct, key: String, listType: KClass<T>, default: MutableList<T> = mutableListOf(), onChange: ArgFun<MutableList<T>>? = null): CSPresetProperty<MutableList<T>>

title

fun Preset.title(parent: CSHasRegistrationsHasDestruct, withModified: Boolean = false): CSHasChangeValue<String>

titleWithModified

fun Preset.titleWithModified(isModified: CSHasChangeValue<Boolean>): CSHasChangeValue<String>

fun Preset.titleWithModified(parent: CSHasRegistrationsHasDestruct): CSHasChangeValue<String>