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/-application | |
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/-application')
-rw-r--r-- | api/pl.treksoft.kvision/-application/-init-.html | 15 | ||||
-rw-r--r-- | api/pl.treksoft.kvision/-application/dispose.html | 17 | ||||
-rw-r--r-- | api/pl.treksoft.kvision/-application/index.html | 78 | ||||
-rw-r--r-- | api/pl.treksoft.kvision/-application/start.html | 21 |
4 files changed, 131 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision/-application/-init-.html b/api/pl.treksoft.kvision/-application/-init-.html new file mode 100644 index 00000000..1426c1af --- /dev/null +++ b/api/pl.treksoft.kvision/-application/-init-.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Application.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision</a> / <a href="index.html">Application</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.Application$<init>()"></a> +<code><span class="identifier">Application</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>Base class for KVision applications.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision/-application/dispose.html b/api/pl.treksoft.kvision/-application/dispose.html new file mode 100644 index 00000000..8d5f7549 --- /dev/null +++ b/api/pl.treksoft.kvision/-application/dispose.html @@ -0,0 +1,17 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Application.dispose - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision</a> / <a href="index.html">Application</a> / <a href="./dispose.html">dispose</a><br/> +<br/> +<h1>dispose</h1> +<a name="pl.treksoft.kvision.Application$dispose()"></a> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">dispose</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><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></code> +<p>Ending point for an application.</p> +<p><strong>Return</strong><br/> +final state for Hot Module Replacement (HMR).</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision/-application/index.html b/api/pl.treksoft.kvision/-application/index.html new file mode 100644 index 00000000..ab4ea5cc --- /dev/null +++ b/api/pl.treksoft.kvision/-application/index.html @@ -0,0 +1,78 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Application - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision</a> / <a href="./index.html">Application</a><br/> +<br/> +<h1>Application</h1> +<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">Application</span></code> +<p>Base class for KVision applications.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Application</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>Base class for KVision applications.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="dispose.html">dispose</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">dispose</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><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></code> +<p>Ending point for an application.</p> +</td> +</tr> +<tr> +<td> +<p><a href="start.html">start</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">start</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>Starting point for an application.</p> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">start</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.Application$start(kotlin.collections.Map((kotlin.String, kotlin.Any)))/state">state</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><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="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Starting point for an application with the state managed by Hot Module Replacement (HMR).</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.panel/root.html">root</a></p> +</td> +<td> +<code><span class="keyword">fun </span><a href="./index.html"><span class="identifier">Application</span></a><span class="symbol">.</span><span class="identifier">root</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel$root(pl.treksoft.kvision.Application, kotlin.String, kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/id">id</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel$root(pl.treksoft.kvision.Application, kotlin.String, kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/fixed">fixed</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel$root(pl.treksoft.kvision.Application, kotlin.String, kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.panel/-root/index.html"><span class="identifier">Root</span></a><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><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.panel/-root/index.html"><span class="identifier">Root</span></a></code> +<p>Create new Root container based on ID</p> +<code><span class="keyword">fun </span><a href="./index.html"><span class="identifier">Application</span></a><span class="symbol">.</span><span class="identifier">root</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel$root(pl.treksoft.kvision.Application, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/element">element</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel$root(pl.treksoft.kvision.Application, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/fixed">fixed</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel$root(pl.treksoft.kvision.Application, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.panel/-root/index.html"><span class="identifier">Root</span></a><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><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.panel/-root/index.html"><span class="identifier">Root</span></a></code> +<p>Create new Root container based on HTML element</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision/-application/start.html b/api/pl.treksoft.kvision/-application/start.html new file mode 100644 index 00000000..5b925e6e --- /dev/null +++ b/api/pl.treksoft.kvision/-application/start.html @@ -0,0 +1,21 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Application.start - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision</a> / <a href="index.html">Application</a> / <a href="./start.html">start</a><br/> +<br/> +<h1>start</h1> +<a name="pl.treksoft.kvision.Application$start()"></a> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">start</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>Starting point for an application.</p> +<a name="pl.treksoft.kvision.Application$start(kotlin.collections.Map((kotlin.String, kotlin.Any)))"></a> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">start</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.Application$start(kotlin.collections.Map((kotlin.String, kotlin.Any)))/state">state</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><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="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Starting point for an application with the state managed by Hot Module Replacement (HMR).</p> +<h3>Parameters</h3> +<p><a name="state"></a> +<code>state</code> - Initial state for Hot Module Replacement (HMR).</p> +</BODY> +</HTML> |