diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api/pl.treksoft.kvision.state/-observable-list | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api/pl.treksoft.kvision.state/-observable-list')
| -rw-r--r-- | api/pl.treksoft.kvision.state/-observable-list/index.html | 77 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.state/-observable-list/on-update.html | 14 |
2 files changed, 91 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.state/-observable-list/index.html b/api/pl.treksoft.kvision.state/-observable-list/index.html new file mode 100644 index 00000000..4b2176c2 --- /dev/null +++ b/api/pl.treksoft.kvision.state/-observable-list/index.html @@ -0,0 +1,77 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ObservableList - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.state</a> / <a href="./index.html">ObservableList</a><br/> +<br/> +<h1>ObservableList</h1> +<code><span class="keyword">interface </span><span class="identifier">ObservableList</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html"><span class="identifier">MutableList</span></a><span class="symbol"><</span><a href="index.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">, </span><a href="../-observable-state/index.html"><span class="identifier">ObservableState</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="index.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">></span></code> +<p>Observable list interface.</p> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="on-update.html">onUpdate</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">onUpdate</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html"><span class="identifier">MutableCollection</span></a><span class="symbol"><</span><span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html"><span class="identifier">MutableList</span></a><span class="symbol"><</span><a href="index.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">></span></code></td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-observable-state/subscribe.html">subscribe</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">subscribe</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.state.ObservableState$subscribe(kotlin.Function1((pl.treksoft.kvision.state.ObservableState.S, kotlin.Unit)))/observer">observer</span><span class="symbol">:</span> <span class="symbol">(</span><a href="../-observable-state/index.html#S"><span class="identifier">S</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Subscribe for the state change notifications.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.collections.-mutable-list/sync-with-list.html">syncWithList</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html"><span class="identifier">MutableList</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.utils/kotlin.collections.-mutable-list/sync-with-list.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">syncWithList</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.utils$syncWithList(kotlin.collections.MutableList((pl.treksoft.kvision.utils.syncWithList.T)), kotlin.collections.List((pl.treksoft.kvision.utils.syncWithList.T)))/list">list</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.utils/kotlin.collections.-mutable-list/sync-with-list.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Utility extension function to synchronise elements of the MutableList.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inheritors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-observable-list-wrapper/index.html">ObservableListWrapper</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">ObservableListWrapper</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html"><span class="identifier">MutableList</span></a><span class="symbol"><</span><a href="../-observable-list-wrapper/index.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">, </span><a href="./index.html"><span class="identifier">ObservableList</span></a><span class="symbol"><</span><a href="../-observable-list-wrapper/index.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">, </span><a href="../-observable-state/index.html"><span class="identifier">ObservableState</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../-observable-list-wrapper/index.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">></span></code> +<p>Simple observable list implementation.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.state/-observable-list/on-update.html b/api/pl.treksoft.kvision.state/-observable-list/on-update.html new file mode 100644 index 00000000..cf3882cf --- /dev/null +++ b/api/pl.treksoft.kvision.state/-observable-list/on-update.html @@ -0,0 +1,14 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>ObservableList.onUpdate - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.state</a> / <a href="index.html">ObservableList</a> / <a href="./on-update.html">onUpdate</a><br/> +<br/> +<h1>onUpdate</h1> +<a name="pl.treksoft.kvision.state.ObservableList$onUpdate"></a> +<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">onUpdate</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html"><span class="identifier">MutableCollection</span></a><span class="symbol"><</span><span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html"><span class="identifier">MutableList</span></a><span class="symbol"><</span><a href="index.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">></span></code> +</BODY> +</HTML> |